sfrbox-api

What it is and what it does

SFR Box API is a Python async client for controlling and monitoring SFR Box routers. It wraps the router's HTTP API using aiohttp for non-blocking I/O and mashumaro for efficient data deserialization, making it suitable for home automation and network monitoring integrations. The package targets developers and system administrators who need programmatic access to router state and configuration.

The library is actively maintained, supports current Python versions (3.10–3.14), and carries no known security vulnerabilities. Its small dependency footprint and low install friction make it straightforward to add to existing projects. However, the published documentation is sparse—the README contains only placeholder sections—so you may need to consult the GitHub repository or ReadTheDocs for actual usage patterns and API reference.

Use it for:

• Monitor SFR Box router status and statistics in a home automation system or dashboard.
• Automate router configuration or reboot tasks from a Python application or scheduled job.
• Integrate SFR Box metrics into a network monitoring or alerting pipeline.
• Build a CLI tool or web service that exposes router controls to non-technical users.
• Test or validate router behavior programmatically in CI/CD or integration test suites.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides an async Python client for interacting with SFR Box routers via their API, using aiohttp for HTTP requests and mashumaro for data serialization.

Yes, if you own an SFR Box router and need async Python access to its API. The package is actively maintained, has no security issues, and imposes minimal install friction. However, the sparse documentation (README contains only TODOs) means you should verify that the actual API methods match your use case before committing—check the GitHub repository and ReadTheDocs for concrete examples and method signatures.

Install

sfrbox-api on PyPI

pip install sfrbox-api

uv add sfrbox-api

poetry add sfrbox-api

Installing sfrbox-api

Before you install

Low install friction with a pure-Python wheel distribution. The package is actively maintained with recent commits and supports modern Python versions (3.10–3.14). Dependencies are lightweight and well-established (aiohttp, defusedxml, mashumaro).

License in practice

MIT license is permissive and imposes no significant restrictions; you can use, modify, and distribute this package freely in commercial or private projects.

Quickstart

pip install sfrbox-api

import asyncio
from sfrbox_api import SFRBoxAPI

async def main():
    async with SFRBoxAPI(host='router.local') as api:
        status = await api.get_status()
        print(status)

Requires Python 3.10 or later; the SFR Box router must be reachable on your network.

Verify before relying

• Actual API methods and data models available—the description excerpt contains only TODO placeholders for features and requirements.
• Whether the package supports authentication (username/password, token, etc.) for SFR Box access.
• Performance characteristics and rate-limiting behavior when querying the router API.
• Compatibility with specific SFR Box hardware models or firmware versions.

Package facts

Evidence: sfrbox_api-0.1.1-py3-none-any.whl

Keywords: sfrbox, router

Tags

More Home Automation packages