pyhubblenetwork 0.0.1__tar.gz

pyhubblenetwork-0.0.1/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

pyhubblenetwork-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

pyhubblenetwork-0.0.1/PKG-INFO

@@ -0,0 +1,322 @@
+Metadata-Version: 2.4
+Name: pyhubblenetwork
+Version: 0.0.1
+Summary: Hubble SDK host-side tools
+Author-email: Paul Buckley <paul@hubble.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: bleak
+Requires-Dist: click
+Requires-Dist: geocoder
+Requires-Dist: httpx>=0.27
+Requires-Dist: pycryptodome
+Requires-Dist: requests
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Hubble Network Python Library
+
+A small, typed Python library and CLI for host‑side interactions with the Hubble SDK. It provides:
+
+* **Stateless utilities**: `scan()` (BLE), `ingest()` (push encrypted packets to the cloud)
+* **Domain objects**: `Organization`, `Device`, `EncryptedPacket`, `DecryptedPacket`, `Location`
+* **CLI** (optional): `hubblenetwork` command that wraps common flows
+
+---
+
+## Installation
+
+### Requirements
+
+* Python **3.9+** (3.11/3.12 recommended)
+* Platform prerequisites if you use BLE scanning (`scan()`):
+
+  * macOS: CoreBluetooth (built‑in); run in a regular user session
+  * Linux: BlueZ; user must have permission to access BLE (often `bluetooth` group)
+  * Windows: requires a compatible BLE stack
+
+### Users (stable release)
+
+```bash
+pip install pyhubblenetwork
+# Or install CLI in an isolated venv:
+pipx install pyhubblenetwork
+```
+
+### Developers (editable install)
+
+From the repo root:
+
+```bash
+cd python
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e .[dev]
+```
+
+---
+
+## Quick start
+
+### Scan locally, then ingest to backend
+
+```python
+from hubblenetwork import ble, Organization
+
+org = Organization(org_id="org_123", api_token="<token>")
+pkt = ble.scan(timeout=5.0)
+if pkt is not None:
+    org.ingest_packet(pkt)
+```
+
+### Manage devices and query packets (Organization API)
+
+```python
+from hubblenetwork import Organization
+
+org = Organization(org_id="org_123", api_token="<token>")
+
+# Create a new device
+new_dev = org.register_device(name="field-node-01")
+print("new device id:", new_dev.id)
+
+# List devices
+for d in org.list_devices():
+    print(d.id, d.name)
+
+# Get packets from a device
+packets = org.get_packets(new_dev)
+if latest:
+    print("latest RSSI:", packets[0].rssi, "payload bytes:", len(packets[0].payload))
+```
+
+### Local decryption (when you have the key)
+
+```python
+from hubblenetwork import Device, ble, decrypt
+
+# Device with a provisioned key
+dev = Device(id="dev_abc", key=b"<secret-key>")
+
+pkts = ble.scan(timeout=5.0)
+if len(pkts) > 0:
+    pkt = pkts[0]
+    maybe_dec = decrypt(dev.key, pkt)
+    if maybe_dec:
+        print("payload:", maybe_dec.payload)
+```
+
+---
+
+## CLI usage (optional)
+
+If installed (via `pipx install`), a `hubblenetwork` command is available.
+
+```bash
+hubblenetwork --help
+hubblenetwork ble scan
+```
+
+---
+
+## Configuration
+
+Some functions (e.g., `org.ingest_packet`) may read defaults from environment variables if not provided explicitly. Suggested variables:
+
+* `HUBBLE_ORG_ID` – default organization id
+* `HUBBLE_API_TOKEN` – API token
+
+You can also provide an explicit `Organization(org_id, api_token)` and pass objects directly where supported.
+
+---
+
+## Public API (summary)
+
+Import from the top‑level package for a stable surface:
+
+```python
+from hubblenetwork import (
+    ble, cloud,
+    Organization, Device,
+    EncryptedPacket, DecryptedPacket, Location,
+)
+```
+
+### Stateless functions
+
+* `ble.scan(timeout: float) -> Optional[EncryptedPacket]` — Listen via BLE and return the first packet observed, or `None` on timeout.
+
+### Classes
+
+* `Organization(org_id: str, api_token: str)`
+
+  * `register_device(name: Optional[str] = None) -> Device`
+  * `list_devices() -> list[Device]`
+  * `get_packets(device: Device | str) -> Optional[DecryptedPacket]`
+* `Device(id: str, key: Optional[bytes] = None, name: Optional[str] = None)`
+* `EncryptedPacket(timestamp, location, payload: bytes, rssi: int)`
+* `DecryptedPacket(timestamp, location, tags: list[str], payload: bytes, rssi: int, counter: Optional[int], sequence: Optional[int])`
+* `Location(lat: float, lon: float, alt_m: Optional[float])`
+
+---
+
+## Project layout
+
+```
+src/hubblenetwork/
+├─ __init__.py       # public API façade (re-exports)
+├─ packets.py        # data models: packets, location, ids
+├─ device.py         # Device class: local decrypt
+├─ crypto.py         # Crypto functionality
+├─ org.py            # Organization class: backend ops
+├─ ble.py            # scan() BLE discovery
+├─ cloud.py          # cloud functionality
+├─ errors.py         # exceptions
+└─ cli/__init__.py   # CLI entry: main()
+```
+
+---
+
+## Development
+
+Run tests and linters from the `python/` directory:
+
+```bash
+pytest -q
+ruff check src
+mypy src
+```
+
+Recommended editor settings:
+
+* Enable `ruff` and `mypy`
+* 100‑column soft wrap
+* `python.analysis.typeCheckingMode = basic/strict` (VS Code)
+
+---
+
+## Versioning & releases
+
+* Follows **SemVer** (MAJOR.MINOR.PATCH)
+* Tagged releases (e.g., `v0.1.0`) publish wheels/sdists to PyPI
+* CLI entry point: `hubblenetwork = "hubblenetwork.cli:main"` (stable)
+
+---
+
+# Testing
+
+This package uses **pytest** with a small set of markers to separate fast unit tests from hardware/OS-dependent integration tests (e.g., BLE).
+
+## Test layout
+
+```
+python/
+├─ src/hubblenetwork/...
+└─ tests/
+   ├─ unit/            # fast, hermetic tests
+   └─ integration/     # slower or environment-dependent tests
+      └─ test_ble_scan.py
+```
+
+Markers (declared in `pyproject.toml`):
+
+* `integration` – slow or environment-dependent tests
+* `ble` – tests that require BLE hardware/permissions
+
+## Setup (one-time per venv)
+
+```bash
+cd python
+python3 -m venv .venv
+source .venv/bin/activate
+
+# Dev tools only:
+pip install -e '.[dev]'
+```
+
+## Running tests
+
+### All fast unit tests
+
+```bash
+pytest -q tests/unit
+```
+
+### Only integration tests
+
+```bash
+pytest -q -m integration
+```
+
+### BLE scan integration test (opt-in)
+
+BLE tests are disabled by default to avoid flakiness on CI or machines without radio permissions. Enable explicitly:
+
+```bash
+export HUBBLE_BLE_TEST=1         # opt-in gate used by the test
+pytest -q -m ble                 # run only BLE-marked tests
+# or target a single file:
+pytest -q tests/integration/test_ble_scan.py
+```
+
+You can adjust the scan timeout:
+
+```bash
+HUBBLE_BLE_TIMEOUT=8 pytest -q -m ble
+```
+
+### Coverage (optional)
+
+```bash
+pytest --cov=hubblenetwork --cov-report=term-missing
+```
+
+### Test Troubleshooting
+
+* **`zsh: no matches found: .[dev]`**
+  Quote the extras spec (zsh globs brackets):
+  `pip install -e '.[dev]'` or `pip install -e '.[dev,ble]'`.
+
+* **BLE on macOS/Linux/Windows**
+
+  * macOS: works in a user session (CoreBluetooth).
+  * Linux: ensure BlueZ is installed and your user has adapter permissions.
+  * Windows: requires a compatible BLE adapter; run in a standard desktop session.
+
+* **Running from repo root**
+  Either change into `python/` before running `pytest`, or pass the path:
+  `pytest -q python/tests`
+
+---
+
+## General Troubleshooting
+
+* **`ble.scan()` finds nothing**: verify BLE permissions and adapter state; try increasing `timeout`.
+* **Auth errors**: confirm `Organization(org_id, api_token)` or env vars are set; check token scope/expiry.
+* **Import errors**: ensure you installed into the Python you’re running (`python -m pip …`). Prefer `pipx` for CLI‑only usage.
+
+---
+
+## Contributing
+
+* Open issues/PRs with clear repro steps
+* Keep modules cohesive; avoid mixing concerns
+* Add/extend unit tests for new behavior
+
+---
+
+## License
+
+This project is licensed under the **MIT License**. See `LICENSE` for details.
+
+---
+
+## Security / responsible disclosure
+
+If you believe you’ve found a security issue, please email [support@hubble.com](mailto:support@hubble.com) with details and a way to reproduce. We’ll acknowledge receipt and follow up promptly.