Skip to main content

Async Python API wrapper for Bouygues Telecom routers

Project description

codecov

aiobbox

Async Python API wrapper for Bouygues Telecom routers.

Tested with model F@st5696b, firmware version 25.5.28.

Usage

  • Supports the following Bbox API endpoints:
    • /login - Authentication
    • /device - Device information
    • /hosts - Connected devices
    • /wan/ip/stats - WAN statistics
import asyncio
from aiobbox import BboxApi

async def main():
    async with BboxApi("your_password") as bbox:
        # Get router's information
        router = await bbox.get_router_info()
        print(f"Router model: {router.modelname}")

        # Get connected hosts
        hosts = await bbox.get_hosts()
        print(f"Connected hosts: {len(hosts)}")

        # Get WAN statistics
        wan_stats = await bbox.get_wan_ip_stats()
        print(f"Download: {wan_stats.rx.bandwidth} Mbps")
        print(f"Upload: {wan_stats.tx.bandwidth} Mbps")

asyncio.run(main())

Development

# Install dependencies and set up development environment
uv sync --dev

# Run tests
uv run pytest

# Run linting and formating
uv run pre-commit run --all-files

# Run integration tests
BBOX_PASSWORD=your_password uv run pytest tests/integration.py -vvs --no-cov

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiobbox-0.3.0.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiobbox-0.3.0-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file aiobbox-0.3.0.tar.gz.

File metadata

  • Download URL: aiobbox-0.3.0.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.8

File hashes

Hashes for aiobbox-0.3.0.tar.gz
Algorithm Hash digest
SHA256 1ef4e0d3a40765684f0f57b553fffdcb2131711c3fa4f882148a6b40cad91338
MD5 65b4e6779c9c506ebc4a740a282a98c3
BLAKE2b-256 1192ba764bb43c83c8d44df019cd9299d67a3b78c41915648ab4819911562efe

See more details on using hashes here.

File details

Details for the file aiobbox-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: aiobbox-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.8

File hashes

Hashes for aiobbox-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c95b0ad81bf482570fcbce96611efbbf1d3e8a69c7485c75871f2876b1caa34e
MD5 61473daf7a68d748e393e31841cf9a0b
BLAKE2b-256 ac6ac487ac28c7b6cfa4d5a6d05d025fe601a4e02838134e8d3bdeb571144731

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page