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.1.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.1-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiobbox-0.3.1.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.1.tar.gz
Algorithm Hash digest
SHA256 fd4cb286abc871f330ae2b1b505e40122c3321401f431be68f140bf69a6c8fd8
MD5 2aabe1903b978b81699125267da8a408
BLAKE2b-256 aaf2a30f9648bab04ef0d27aeaef65b3163ca2618cc8f3e27fff56912e8cff62

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for aiobbox-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1768fdb487cb1f0c5a67d3347149aeab5aeba674e36cf20b11181ee601eb8b5d
MD5 325e53058ae8df92af47f318a5cd4b26
BLAKE2b-256 b28b3fbeec72aa4043aaf117ef42f023ccf8df7c60f85a61b79d310ddbcc7dc0

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