connect-box3
Python API Client to interact with a Connect Box 3 modem/router.
For older hardware revisions (e. g., UPC Connect Box 2), please use connect-box.
The device could be provided under different names by various ISP in Europe.
Currently tested with:
| Provider | Name | Model |
|---|---|---|
| Sunrise | Connect Box 3 | F5685LGB |
This module is not official, developed, supported or endorsed by Sunrise, UPC, Unitymedia or Compal.
Installation
connect-box3 is available on PyPI.
pip3 install connect-box3
For NixOS, the package is available from Nixpkgs.
nix-env -iA nixos.python3Packages.connect-box3
Usage
connect-box is a CLI application that show-cases the functionality of the module.
connect-box system --password xxx --host 192.168.1.1
system
┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃ Field ┃ Value ┃
┡━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ modelName │ F5685LGB │
│ softwareVersion │ 4.11.1-2309.6 │
│ hardwareVersion │ 1.2.1b │
└─────────────────┴───────────────┘
See also example.py for usage examples.
Development
Running tests
Tests use hatch to manage the test environment. To run the test suite:
hatch run test:run
To run a specific test file or test:
hatch run test:run tests/test_client.py
hatch run test:run -k test_login
Linting
hatch run ruff check .
hatch run ruff format --check .
License
Licensed under MIT. See LICENSE for details.
Metadata
Release files for connect-box3 0.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| connect_box3-0.2.2.tar.gz | 17.3 kB | With provenance | Details for connect_box3-0.2.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| connect_box3-0.2.2-py3-none-any.whl | Python 3 | none | any | Details for connect_box3-0.2.2-py3-none-any.whl |
Total release size: 29.0 kB
Release files / connect_box3-0.2.2.tar.gz
| Download URL | connect_box3-0.2.2.tar.gz |
|---|---|
| Size | 17.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6404652d4f481b449b81ae3b634d01b982b6e3bfd5431daab41c0f599927dc53
|
|
BLAKE2b-256 checksum How to use checksums |
b14bcd12e8989c494ce1cb9e67fc44a443d38c9846059c91acd97a69b0b897eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 25, 2026.
Transparency logRelease files / connect_box3-0.2.2-py3-none-any.whl
| Download URL | connect_box3-0.2.2-py3-none-any.whl |
|---|---|
| Size | 11.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
91c51ca32dbf4c8152183632b68b1d2e8fa98a81ca7223f86a0440d35cccf679
|
|
BLAKE2b-256 checksum How to use checksums |
d141f9ed6df9e1be8a9d85b014d051c7b5774f7be5bd4c8d2ee18532242ab826
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 25, 2026.
Transparency logSecurity for connect-box3 0.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for connect_box3-0.2.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 25, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.