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.1.0.tar.gz (5.1 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.1.0-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aiobbox-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1b54da1db52ecefbf9585526c8edc515451b4f1743d141eb989abd3b932ee623
MD5 c93d7f0a0a7ed26b752b0cf62c632548
BLAKE2b-256 121e610057bfe936ad4e786707c0752688a472e1fcfb423c29751cf9000c2bf8

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for aiobbox-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b21e39540a643459fd16491f913aa5196e9a703e3dbc49a942c27abf5f057b26
MD5 6d098bdf21faba1c37f341f3ab4fb4b4
BLAKE2b-256 ff85c8805e2b5030ea5719f541768d6a096f854825e8207da68d6001c30c88b1

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