hb-client 0.5.3__tar.gz

hb_client-0.5.3/LICENSE

@@ -0,0 +1,17 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2026, J. Will Pierce
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hb_client-0.5.3/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: hb-client
+Version: 0.5.3
+Summary: Secure heartbeat client for the Nuclei monitoring ecosystem
+Author-email: "J. Will Pierce" <willp@users.noreply.github.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/willp/heartbeat-client
+Project-URL: Repository, https://github.com/willp/heartbeat-client
+Project-URL: Documentation, https://github.com/willp/heartbeat-client/blob/main/README.md
+Project-URL: Issues, https://github.com/willp/heartbeat-client/issues
+Project-URL: Changelog, https://github.com/willp/heartbeat-client/blob/main/CHANGELOG.md
+Keywords: heartbeat,monitoring,nuclei,client,heartbeat-monitoring
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography>=41.0.0
+Requires-Dist: filelock>=3.12.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: pytest>=8.3.0; extra == "dev"
+Requires-Dist: ruff>=0.6.0; extra == "dev"
+Requires-Dist: twine>=5.1.0; extra == "dev"
+Provides-Extra: typecheck
+Requires-Dist: mypy>=1.11.0; extra == "typecheck"
+Provides-Extra: release
+Requires-Dist: commitizen>=3.29.0; extra == "release"
+Dynamic: license-file
+
+# hb-client
+
+A secure, high-reliability heartbeat client for monitoring your systems
+using `hbserver` and `hbwatcher`.
+
+## Project Scope
+
+This repository contains only the Python client library and CLI for sending
+heartbeat packets and managing local enrollment keys.
+
+Related repositories:
+
+- `hbserver` (`hb_backend`): API/authentication and key lifecycle services
+- `hbwatcher` (`hb_watcher`): monitoring process that evaluates heartbeat data
+
+## Installation
+
+```bash
+pip install hb-client
+```
+
+See [MIGRATION.md](MIGRATION.md) if upgrading from older distribution or config paths.
+
+This installs:
+
+- the Python package `hb_client`
+- the CLI command `hbclient`
+
+## Quick Start
+
+### As a library
+
+```python
+from hb_client import HbClient, HbConfig
+
+config = HbConfig(server="hb.example.com", serverport=8333)
+client = HbClient(name="my-service", interval=60, config=config)
+client.send(task="deployment-complete")
+client.close()
+```
+
+### From the CLI
+
+```bash
+hbclient --server-url https://hb.example.com:8333 login
+hbclient --server-url https://hb.example.com:8333 status
+hbclient send --app my-service --task deploy --interval 60
+```
+
+## Features
+
+- **AES-GCM encrypted UDP transport** with CRC32 integrity
+- **OAuth Device Flow** for key management
+- **Secure by default** with `strict_security=True`
+- **Transparent DNS resolution** with configurable refresh intervals
+- **Deterministic key rotation** with jitter to prevent thundering herd
+- **Atomic file I/O** for crash-safe credential storage
+- **Human-readable duration parsing** (e.g., `6h`, `2.5d`, `3w`)
+
+## Configuration
+
+Enrollment keys are stored under:
+
+- Linux: `$XDG_CONFIG_HOME/hbclient/` or `~/.config/hbclient/`
+- macOS: `~/Library/Application Support/hbclient/`
+- Windows: `%APPDATA%/hbclient/`
+
+## Security Mode (`strict_security`)
+
+`HbClient` accepts `strict_security` (default: `True`). If enrollment is missing, construction raises `RuntimeError` with guidance to run:
+
+```bash
+hbclient --server-url https://hb.example.com:8333 login
+```
+
+## CLI Reference
+
+```
+hbclient [--server SERVER] [--serverport PORT] [--server-url URL] COMMAND
+```
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+make test
+make pre-release
+```
+
+## Releasing
+
+```bash
+pip install -e ".[release]"
+cz bump
+make pre-release
+python -m twine upload dist/hb_client-<version>*
+```
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE)

hb_client-0.5.3/README.md

@@ -0,0 +1,101 @@
+# hb-client
+
+A secure, high-reliability heartbeat client for monitoring your systems
+using `hbserver` and `hbwatcher`.
+
+## Project Scope
+
+This repository contains only the Python client library and CLI for sending
+heartbeat packets and managing local enrollment keys.
+
+Related repositories:
+
+- `hbserver` (`hb_backend`): API/authentication and key lifecycle services
+- `hbwatcher` (`hb_watcher`): monitoring process that evaluates heartbeat data
+
+## Installation
+
+```bash
+pip install hb-client
+```
+
+See [MIGRATION.md](MIGRATION.md) if upgrading from older distribution or config paths.
+
+This installs:
+
+- the Python package `hb_client`
+- the CLI command `hbclient`
+
+## Quick Start
+
+### As a library
+
+```python
+from hb_client import HbClient, HbConfig
+
+config = HbConfig(server="hb.example.com", serverport=8333)
+client = HbClient(name="my-service", interval=60, config=config)
+client.send(task="deployment-complete")
+client.close()
+```
+
+### From the CLI
+
+```bash
+hbclient --server-url https://hb.example.com:8333 login
+hbclient --server-url https://hb.example.com:8333 status
+hbclient send --app my-service --task deploy --interval 60
+```
+
+## Features
+
+- **AES-GCM encrypted UDP transport** with CRC32 integrity
+- **OAuth Device Flow** for key management
+- **Secure by default** with `strict_security=True`
+- **Transparent DNS resolution** with configurable refresh intervals
+- **Deterministic key rotation** with jitter to prevent thundering herd
+- **Atomic file I/O** for crash-safe credential storage
+- **Human-readable duration parsing** (e.g., `6h`, `2.5d`, `3w`)
+
+## Configuration
+
+Enrollment keys are stored under:
+
+- Linux: `$XDG_CONFIG_HOME/hbclient/` or `~/.config/hbclient/`
+- macOS: `~/Library/Application Support/hbclient/`
+- Windows: `%APPDATA%/hbclient/`
+
+## Security Mode (`strict_security`)
+
+`HbClient` accepts `strict_security` (default: `True`). If enrollment is missing, construction raises `RuntimeError` with guidance to run:
+
+```bash
+hbclient --server-url https://hb.example.com:8333 login
+```
+
+## CLI Reference
+
+```
+hbclient [--server SERVER] [--serverport PORT] [--server-url URL] COMMAND
+```
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+make test
+make pre-release
+```
+
+## Releasing
+
+```bash
+pip install -e ".[release]"
+cz bump
+make pre-release
+python -m twine upload dist/hb_client-<version>*
+```
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE)

hb_client-0.5.3/pyproject.toml

@@ -0,0 +1,90 @@
+[build-system]
+requires = ["setuptools>=69.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hb-client"
+version = "0.5.3"
+description = "Secure heartbeat client for the Nuclei monitoring ecosystem"
+readme = {file = "README.md", content-type = "text/markdown"}
+requires-python = ">=3.10"
+license = "Apache-2.0"
+authors = [
+    {name = "J. Will Pierce", email = "willp@users.noreply.github.com"},
+]
+keywords = ["heartbeat", "monitoring", "nuclei", "client", "heartbeat-monitoring"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3 :: Only",
+    "Operating System :: OS Independent",
+    "Topic :: System :: Monitoring",
+]
+dependencies = [
+    "cryptography>=41.0.0",
+    "filelock>=3.12.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "build>=1.2.2",
+    "pytest>=8.3.0",
+    "ruff>=0.6.0",
+    "twine>=5.1.0",
+]
+typecheck = [
+    "mypy>=1.11.0",
+]
+release = [
+    "commitizen>=3.29.0",
+]
+
+[project.urls]
+Homepage      = "https://github.com/willp/heartbeat-client"
+Repository    = "https://github.com/willp/heartbeat-client"
+Documentation = "https://github.com/willp/heartbeat-client/blob/main/README.md"
+Issues        = "https://github.com/willp/heartbeat-client/issues"
+Changelog     = "https://github.com/willp/heartbeat-client/blob/main/CHANGELOG.md"
+
+[project.scripts]
+hbclient = "hb_client.hbclient:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["hb_client*"]
+
+[tool.pytest.ini_options]
+minversion = "8.0"
+testpaths = ["tests"]
+addopts = "-ra"
+
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+ignore = ["E501"]
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false
+check_untyped_defs = true
+no_implicit_optional = true
+strict_equality = true
+pretty = true
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "$version"
+version_scheme = "pep440"
+version_provider = "pep621"
+update_changelog_on_bump = true
+major_version_zero = true

hb_client-0.5.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hb_client-0.5.3/src/hb_client/__init__.py

@@ -0,0 +1,31 @@
+from importlib.metadata import PackageNotFoundError, version
+
+from .hbclient import (
+    CLI_NAME,
+    CONFIG_DIR_NAME,
+    HbClient,
+    HbConfig,
+    KeyManager,
+    cmd_login,
+    cmd_logout,
+    cmd_status,
+    parse_time_duration,
+)
+
+try:
+    __version__ = version(__name__)
+except PackageNotFoundError:
+    __version__ = "unknown"
+
+__all__ = [
+    "CLI_NAME",
+    "CONFIG_DIR_NAME",
+    "HbClient",
+    "HbConfig",
+    "KeyManager",
+    "cmd_login",
+    "cmd_status",
+    "cmd_logout",
+    "parse_time_duration",
+    "__version__",
+]