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 -v -s

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.2.0.tar.gz (5.2 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.2.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aiobbox-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0992e305e003191fd709c65fb4057a7fd17139f1a4e1a33944f4b8252942c8b5
MD5 eddf6e5b390c96841ce1178baaf74e31
BLAKE2b-256 2804068c8d2e9e5e2d39ccd8cb44ae8cbc643510a65f9152cedbde6e8c971e21

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for aiobbox-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8eb9daab9f63461ac9572605b9ad81cb816e71caf99321afffd04015ec95d303
MD5 29005afbac364690d6684e020c01a6a6
BLAKE2b-256 641d6300eeadea3321d4cf2d6701ffc73c375050a62570aea54ca93bfba6204b

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