bboxpy


Namebboxpy JSON
Version 1.3.4 PyPI version JSON
download
home_pageNone
SummaryFetch data from bouygues bbox
upload_time2024-12-18 21:30:54
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10.0
licenseGPL-3
keywords bouygues async bbox
VCS
bugtrack_url
requirements aiohttp
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # bboxpy

Manage your Bouygues Bbox in Python

Easily manage your Bbox in Python.
Check your config, configure your dhcp, disable your wifi, monitor your LAN activity and many others, on LAN or remotely.

bboxpy is a python library implementing fir the Bbox.

This project is based on stilllman/aiofreepybox, which provides the same features as aiofreepybox in a synchronous manner.

## Install

Use the PIP package manager

```bash
$ pip install bboxpy
```

Or manually download and install the last version from github

```bash
$ git clone https://github.com/cyr-ius/bboxpy.git
$ python setup.py install
```

## Get started

```python
# Import the bboxpy package.
from bboxpy import Bbox
from bboxpy.exceptions import BboxException

async def async_main()
    # Instantiate the Sysbus class using default options.
    bbox = Bbox(password='xxxxxx')

    # Connect. (optional)
    await bbox.async_login()

    try:
        device_info = await bbox.device.async_get_bbox_info()
        print(device_info)
    except BboxException as error:
        logger.error(error)

    # Do something useful, rebooting your bbox for example.
    await bbox.device.async_reboot()

    # Properly close the session.
    await bbox.async_logout()
    await bbox.async_close()

    #Call api (raw mode)
    summary = await bbox.async_raw_request(method="get", path="device/summary")
    print(summary)


if __name__ == "__main__":
    loop = asyncio.new_event_loop()
    asyncio.set_event_loop(loop)
    asyncio.run(async_main())

```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "bboxpy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10.0",
    "maintainer_email": null,
    "keywords": "bouygues, async, bbox",
    "author": null,
    "author_email": "Cyr-ius <cyr-ius@ipocus.net>",
    "download_url": "https://files.pythonhosted.org/packages/35/cd/45929186b2e151f23a681f5e8868c310de19494288a01a082550f48fd6fb/bboxpy-1.3.4.tar.gz",
    "platform": "any",
    "description": "# bboxpy\n\nManage your Bouygues Bbox in Python\n\nEasily manage your Bbox in Python.\nCheck your config, configure your dhcp, disable your wifi, monitor your LAN activity and many others, on LAN or remotely.\n\nbboxpy is a python library implementing fir the Bbox.\n\nThis project is based on stilllman/aiofreepybox, which provides the same features as aiofreepybox in a synchronous manner.\n\n## Install\n\nUse the PIP package manager\n\n```bash\n$ pip install bboxpy\n```\n\nOr manually download and install the last version from github\n\n```bash\n$ git clone https://github.com/cyr-ius/bboxpy.git\n$ python setup.py install\n```\n\n## Get started\n\n```python\n# Import the bboxpy package.\nfrom bboxpy import Bbox\nfrom bboxpy.exceptions import BboxException\n\nasync def async_main()\n    # Instantiate the Sysbus class using default options.\n    bbox = Bbox(password='xxxxxx')\n\n    # Connect. (optional)\n    await bbox.async_login()\n\n    try:\n        device_info = await bbox.device.async_get_bbox_info()\n        print(device_info)\n    except BboxException as error:\n        logger.error(error)\n\n    # Do something useful, rebooting your bbox for example.\n    await bbox.device.async_reboot()\n\n    # Properly close the session.\n    await bbox.async_logout()\n    await bbox.async_close()\n\n    #Call api (raw mode)\n    summary = await bbox.async_raw_request(method=\"get\", path=\"device/summary\")\n    print(summary)\n\n\nif __name__ == \"__main__\":\n    loop = asyncio.new_event_loop()\n    asyncio.set_event_loop(loop)\n    asyncio.run(async_main())\n\n```\n",
    "bugtrack_url": null,
    "license": "GPL-3",
    "summary": "Fetch data from bouygues bbox",
    "version": "1.3.4",
    "project_urls": {
        "Homepage": "https://github.com/cyr-ius/bboxpy"
    },
    "split_keywords": [
        "bouygues",
        " async",
        " bbox"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "031aea243aefc47a3d1ec663a725f9365acb4d3952648f7c0369d701d5ba610d",
                "md5": "6b1e21b9bf340a4fdcc54971aba733c6",
                "sha256": "e5e01cd0eef642595168d31794bbe916ee469d2e400b8e09ba48762ceb8278e6"
            },
            "downloads": -1,
            "filename": "bboxpy-1.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6b1e21b9bf340a4fdcc54971aba733c6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10.0",
            "size": 24397,
            "upload_time": "2024-12-18T21:30:49",
            "upload_time_iso_8601": "2024-12-18T21:30:49.899406Z",
            "url": "https://files.pythonhosted.org/packages/03/1a/ea243aefc47a3d1ec663a725f9365acb4d3952648f7c0369d701d5ba610d/bboxpy-1.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "35cd45929186b2e151f23a681f5e8868c310de19494288a01a082550f48fd6fb",
                "md5": "0c7b97873f9e2391fbd38345fce51120",
                "sha256": "2c1fc0b971f408af9b4f4843e5388b21e390c7cd9abdf5d6e5a9739c0c716aad"
            },
            "downloads": -1,
            "filename": "bboxpy-1.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "0c7b97873f9e2391fbd38345fce51120",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10.0",
            "size": 30569,
            "upload_time": "2024-12-18T21:30:54",
            "upload_time_iso_8601": "2024-12-18T21:30:54.807978Z",
            "url": "https://files.pythonhosted.org/packages/35/cd/45929186b2e151f23a681f5e8868c310de19494288a01a082550f48fd6fb/bboxpy-1.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-18 21:30:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cyr-ius",
    "github_project": "bboxpy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "aiohttp",
            "specs": [
                [
                    ">=",
                    "3.8.3"
                ]
            ]
        }
    ],
    "lcname": "bboxpy"
}
        
Elapsed time: 0.39329s