bbox-api 0.1.0__tar.gz

bbox_api-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+.idea/
+.pytest_cache/
+.ruff_cache/
+htmlcov/
+.coverage

bbox_api-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 rettelx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bbox_api-0.1.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.5
+Name: bbox-api
+Version: 0.1.0
+Summary: Async Python client for the Bouygues Telecom Bbox router API
+Project-URL: Homepage, https://github.com/xavier/bbox-api
+Project-URL: Repository, https://github.com/xavier/bbox-api
+Project-URL: Issues, https://github.com/xavier/bbox-api/issues
+Project-URL: Documentation, https://github.com/xavier/bbox-api#readme
+Author: rettelx
+License-Expression: MIT
+License-File: LICENSE
+Keywords: aiohttp,api,async,bbox,bouygues,bouygues-telecom,gateway,router
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.9
+Provides-Extra: dev
+Requires-Dist: aiohttp<3.14,>=3.9; extra == 'dev'
+Requires-Dist: aioresponses>=0.7; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-asyncio>=1; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: aiohttp<3.14,>=3.9; extra == 'test'
+Requires-Dist: aioresponses>=0.7; extra == 'test'
+Requires-Dist: pytest-asyncio>=1; extra == 'test'
+Requires-Dist: pytest>=8; extra == 'test'
+Description-Content-Type: text/markdown
+
+# bbox-api
+
+Async client for the **Bouygues Telecom Bbox router API** (`/api/v1`), for any
+asyncio app. Python >= 3.11, MIT, single dependency (`aiohttp`), fully typed
+(`py.typed`, mypy-clean) with fault-tolerant dataclass models (unknown or
+malformed payload keys never crash parsing; unknown keys stay in `.raw`).
+
+- **Local**: `BboxClient(pw)` → `http://bbox.lan/api/v1` (also `192.168.1.1` or
+  `mabbox.bytel.fr` with `use_tls=True` — that name resolves only on the LAN,
+  the box hijacks DNS for it). **Remote**: `BboxClient.remote(pw, wan_ip)` →
+  `https://<wan-ip>/api/v1` ("remote access" enabled on the box; the WAN IP is
+  refused from the LAN itself).
+- **Auth is automatic**: admin password → session cookie + cached `btoken`,
+  re-auth on 401, retries on transient errors.
+
+## Install
+
+```bash
+pip install bbox-api
+```
+
+## Usage
+
+```python
+import asyncio
+from bbox_api import BboxClient
+
+
+async def main():
+    async with BboxClient("admin-password") as client:  # local: bbox.lan
+        device = await client.get_device()  # model, firmware, uptime
+        stats = await client.get_wan_ip_stats()  # rx/tx bandwidth_mbps
+        hosts = await client.get_hosts()  # connected devices
+        await client.set_wireless(False)  # all main Wi-Fi bands off
+
+
+asyncio.run(main())
+```
+
+Any endpoint not wrapped by a typed method: `await client.raw_request("alerts")`.
+To share your own `aiohttp.ClientSession`, pass `session=` — the client then
+never closes it.
+
+## Errors
+
+All inherit `BboxApiError`: `BboxInvalidCredentialsError`, `BboxSessionExpiredError`, `BboxRateLimitError`, `BboxNotFoundError`, `BboxConnectionError`, `BboxTimeoutError`.
+
+## Verified endpoints (live-tested on a F@st5688b, fw 25.1.22)
+
+GET endpoints returning HTTP 200, grouped by area:
+
+- **device**: `device`, `device/cpu`, `device/mem`, `device/summary`, `device/log`, `device/led`
+- **hosts**: `hosts`, `hosts/me`, `alerts`
+- **wan**: `wan/ip`, `wan/ip/stats`, `wan/ftth/stats`, `wan/diags`, `cpl`
+- **wireless**: `wireless`, `wireless/24`, `wireless/5`, `wireless/6`, `wireless/guest`,
+  `wireless/24/stats`, `wireless/5/stats`, `wireless/6/stats`, `wireless/wps`,
+  `wireless/repeater`, `wireless/scheduler`
+- **lan / misc**: `summary`, `lan/ip`, `lan/stats`, `iptv`, `services`, `speedtest`,
+  `parentalcontrol`, `voip`, `voip/fullcalllog/<line-id>` (line id from `GET /voip`,
+  e.g. `voip/fullcalllog/1`)
+
+GET endpoints returning 404 on this model/firmware (they raise `BboxNotFoundError`):
+
+- `device/optimization`, `wan/ftth`, `wan/xdsl`, `wan/xdsl/stats`, `wan/cable`
+  (this is a FTTH box), `lan/ip6`, `ddns`, `remote`, `voip/voicemail`,
+  `voip/callforward`, `voip/fullcalllog` without a line id
+
+Writes verified (PUT/POST/DELETE with `btoken`):
+
+- `PUT /wireless` + `radio.enable=0/1` — toggles all main bands (2.4/5/6 GHz) at once
+- `PUT /wireless/guestenable` + `enable=0/1` — guest Wi-Fi
+- `POST` / `DELETE /wireless/wps` — start/stop a WPS session
+
+Behavior notes from live testing:
+
+- `/hosts` returns a **list of blocks**: the first is the main LAN, the following
+  ones are e.g. the guest network (entries flagged `guest=1`, 10.0.0.x subnet).
+  The guest block stays present even when guest Wi-Fi is off (its hosts just show
+  `active=False`). `get_hosts()` parses all blocks and excludes guests unless
+  `include_guests=True`; `get_guests()` returns only guest hosts.
+
+Security warning: `GET /wireless` returns the **Wi-Fi passphrase in clear text**
+(`raw["bands"]["24"]["security"]["passphrase"]`). Never expose a model's `raw`
+dict in logs or API responses.
+
+## Development
+
+```bash
+python -m venv .venv && .venv/Scripts/pip install -e ".[dev]"
+.venv/Scripts/python -m pytest        # 44 tests, mocked API (aiohttp<3.14: aioresponses limit)
+.venv/Scripts/ruff check .
+.venv/Scripts/python -m mypy
+```
+
+CI/CD (`.github/workflows/`): `ci.yml` runs pytest on Python 3.11–3.14 plus
+ruff and mypy on every push/PR; `release.yml` builds the wheel/sdist with
+hatchling and publishes to PyPI on `v*` tags via trusted publishing (OIDC —
+configure the `bbox-api` project on PyPI with this repo as trusted publisher,
+no API token needed).
+
+## License
+
+MIT

bbox_api-0.1.0/README.md

@@ -0,0 +1,103 @@
+# bbox-api
+
+Async client for the **Bouygues Telecom Bbox router API** (`/api/v1`), for any
+asyncio app. Python >= 3.11, MIT, single dependency (`aiohttp`), fully typed
+(`py.typed`, mypy-clean) with fault-tolerant dataclass models (unknown or
+malformed payload keys never crash parsing; unknown keys stay in `.raw`).
+
+- **Local**: `BboxClient(pw)` → `http://bbox.lan/api/v1` (also `192.168.1.1` or
+  `mabbox.bytel.fr` with `use_tls=True` — that name resolves only on the LAN,
+  the box hijacks DNS for it). **Remote**: `BboxClient.remote(pw, wan_ip)` →
+  `https://<wan-ip>/api/v1` ("remote access" enabled on the box; the WAN IP is
+  refused from the LAN itself).
+- **Auth is automatic**: admin password → session cookie + cached `btoken`,
+  re-auth on 401, retries on transient errors.
+
+## Install
+
+```bash
+pip install bbox-api
+```
+
+## Usage
+
+```python
+import asyncio
+from bbox_api import BboxClient
+
+
+async def main():
+    async with BboxClient("admin-password") as client:  # local: bbox.lan
+        device = await client.get_device()  # model, firmware, uptime
+        stats = await client.get_wan_ip_stats()  # rx/tx bandwidth_mbps
+        hosts = await client.get_hosts()  # connected devices
+        await client.set_wireless(False)  # all main Wi-Fi bands off
+
+
+asyncio.run(main())
+```
+
+Any endpoint not wrapped by a typed method: `await client.raw_request("alerts")`.
+To share your own `aiohttp.ClientSession`, pass `session=` — the client then
+never closes it.
+
+## Errors
+
+All inherit `BboxApiError`: `BboxInvalidCredentialsError`, `BboxSessionExpiredError`, `BboxRateLimitError`, `BboxNotFoundError`, `BboxConnectionError`, `BboxTimeoutError`.
+
+## Verified endpoints (live-tested on a F@st5688b, fw 25.1.22)
+
+GET endpoints returning HTTP 200, grouped by area:
+
+- **device**: `device`, `device/cpu`, `device/mem`, `device/summary`, `device/log`, `device/led`
+- **hosts**: `hosts`, `hosts/me`, `alerts`
+- **wan**: `wan/ip`, `wan/ip/stats`, `wan/ftth/stats`, `wan/diags`, `cpl`
+- **wireless**: `wireless`, `wireless/24`, `wireless/5`, `wireless/6`, `wireless/guest`,
+  `wireless/24/stats`, `wireless/5/stats`, `wireless/6/stats`, `wireless/wps`,
+  `wireless/repeater`, `wireless/scheduler`
+- **lan / misc**: `summary`, `lan/ip`, `lan/stats`, `iptv`, `services`, `speedtest`,
+  `parentalcontrol`, `voip`, `voip/fullcalllog/<line-id>` (line id from `GET /voip`,
+  e.g. `voip/fullcalllog/1`)
+
+GET endpoints returning 404 on this model/firmware (they raise `BboxNotFoundError`):
+
+- `device/optimization`, `wan/ftth`, `wan/xdsl`, `wan/xdsl/stats`, `wan/cable`
+  (this is a FTTH box), `lan/ip6`, `ddns`, `remote`, `voip/voicemail`,
+  `voip/callforward`, `voip/fullcalllog` without a line id
+
+Writes verified (PUT/POST/DELETE with `btoken`):
+
+- `PUT /wireless` + `radio.enable=0/1` — toggles all main bands (2.4/5/6 GHz) at once
+- `PUT /wireless/guestenable` + `enable=0/1` — guest Wi-Fi
+- `POST` / `DELETE /wireless/wps` — start/stop a WPS session
+
+Behavior notes from live testing:
+
+- `/hosts` returns a **list of blocks**: the first is the main LAN, the following
+  ones are e.g. the guest network (entries flagged `guest=1`, 10.0.0.x subnet).
+  The guest block stays present even when guest Wi-Fi is off (its hosts just show
+  `active=False`). `get_hosts()` parses all blocks and excludes guests unless
+  `include_guests=True`; `get_guests()` returns only guest hosts.
+
+Security warning: `GET /wireless` returns the **Wi-Fi passphrase in clear text**
+(`raw["bands"]["24"]["security"]["passphrase"]`). Never expose a model's `raw`
+dict in logs or API responses.
+
+## Development
+
+```bash
+python -m venv .venv && .venv/Scripts/pip install -e ".[dev]"
+.venv/Scripts/python -m pytest        # 44 tests, mocked API (aiohttp<3.14: aioresponses limit)
+.venv/Scripts/ruff check .
+.venv/Scripts/python -m mypy
+```
+
+CI/CD (`.github/workflows/`): `ci.yml` runs pytest on Python 3.11–3.14 plus
+ruff and mypy on every push/PR; `release.yml` builds the wheel/sdist with
+hatchling and publishes to PyPI on `v*` tags via trusted publishing (OIDC —
+configure the `bbox-api` project on PyPI with this repo as trusted publisher,
+no API token needed).
+
+## License
+
+MIT

bbox_api-0.1.0/pyproject.toml

@@ -0,0 +1,89 @@
+[build-system]
+requires = ["hatchling>=1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "bbox-api"
+version = "0.1.0"
+description = "Async Python client for the Bouygues Telecom Bbox router API"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+authors = [{ name = "rettelx" }]
+keywords = [
+    "bbox",
+    "bouygues",
+    "bouygues-telecom",
+    "router",
+    "gateway",
+    "api",
+    "async",
+    "aiohttp",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Framework :: AsyncIO",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = ["aiohttp>=3.9"]
+
+[project.optional-dependencies]
+test = [
+    "pytest>=8",
+    "pytest-asyncio>=1",
+    "aioresponses>=0.7",
+    # aioresponses 0.7.x does not support aiohttp 3.14 yet (ClientResponse
+    # gained a required stream_writer arg); CI pins aiohttp<3.14 for tests.
+    "aiohttp>=3.9,<3.14",
+]
+dev = [
+    "bbox-api[test]",
+    "ruff",
+    "mypy",
+]
+
+[project.urls]
+Homepage = "https://github.com/xavier/bbox-api"
+Repository = "https://github.com/xavier/bbox-api"
+Issues = "https://github.com/xavier/bbox-api/issues"
+Documentation = "https://github.com/xavier/bbox-api#readme"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/bbox_api"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/bbox_api", "tests", "README.md", "LICENSE"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+addopts = "--strict-markers"
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "B", "C4", "UP", "SIM", "RUF"]
+ignore = ["SIM108"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["bbox_api"]
+
+[tool.mypy]
+python_version = "3.11"
+files = ["src/bbox_api"]
+warn_unused_ignores = true
+warn_redundant_casts = true
+disallow_untyped_defs = true

bbox_api-0.1.0/src/bbox_api/__init__.py

@@ -0,0 +1,60 @@
+"""Async Python client for the Bouygues Telecom Bbox router API."""
+
+from .client import BboxClient
+from .exceptions import (
+    BboxApiError,
+    BboxAuthenticationError,
+    BboxConnectionError,
+    BboxInvalidCredentialsError,
+    BboxNotFoundError,
+    BboxRateLimitError,
+    BboxSessionExpiredError,
+    BboxTimeoutError,
+)
+from .models import (
+    WANIP,
+    BboxModel,
+    ConnectionFlags,
+    DeviceInfo,
+    Display,
+    EthernetInfo,
+    FirmwareVersion,
+    Host,
+    IPv6Address,
+    WANIPStats,
+    WANStats,
+    Wireless,
+    WirelessBand,
+    WirelessInfo,
+    WirelessRadio,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "WANIP",
+    "BboxApiError",
+    "BboxAuthenticationError",
+    "BboxClient",
+    "BboxConnectionError",
+    "BboxInvalidCredentialsError",
+    "BboxModel",
+    "BboxNotFoundError",
+    "BboxRateLimitError",
+    "BboxSessionExpiredError",
+    "BboxTimeoutError",
+    "ConnectionFlags",
+    "DeviceInfo",
+    "Display",
+    "EthernetInfo",
+    "FirmwareVersion",
+    "Host",
+    "IPv6Address",
+    "WANIPStats",
+    "WANStats",
+    "Wireless",
+    "WirelessBand",
+    "WirelessInfo",
+    "WirelessRadio",
+    "__version__",
+]