| Name | aiosysbus JSON |
| Version |
1.1.8
JSON |
| download |
| home_page | None |
| Summary | Provides asynchronous authentication and access to Livebox |
| upload_time | 2024-05-27 16:19:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | GPL-3 |
| keywords |
livebox
async
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# aiosysbus
Manage your Livebox in Python
Easily manage your Livebox in Python.
Check your config, configure your dhcp, disable your wifi, monitor your LAN activity and many others, on LAN or remotely.
aiosysbus is a python library implementing fir the Livebox v3.
This project is based on stilllman/aiofreepybox, which provides the same features as aiofreepybox in a synchronous manner.
## WARNING
**Version 1.0.0 and above** makes all these calls asynchronously.
It breaks the compatibility of previous codes
## Install
Use the PIP package manager
```bash
$ pip install aiosysbus
```
Or manually download and install the last version from github
```bash
$ git clone https://github.com/cyr-ius/aiosysbus.git
$ python setup.py install
```
## Get started
aiosysbus < 1.0.0
```python
# Import the aiosysbus package.
from aiosysbus import AIOSysbus
async def reboot()
# Instantiate the Sysbus class using default options.
lvbx = AIOSysbus('192.168.1.1','80','xxxxxx')
# Connect to the livebox with default options.
lvbx.connect()
# Do something useful, rebooting your livebox for example.
lvbx.system.reboot()
# Properly close the session.
lvbx.close()
```
aiosysbus >= 1.0.0
```python
import asyncio
import logging
async def async_main() -> None:
# Instantiate the Sysbus class using default options.
api = AIOSysbus(username=xxxx, password=xxxx, host=HOST)
# Connect to the livebox.
await api.async_connect()
# Query example
parameters = {"parameters": {"expression": {"wifi": "wifi && .Active==False"}}}
devices = await api.devices.async_get_devices(parameters)
await api.async_close()
if __name__ == "__main__":
loop = asyncio.get_event_loop()
loop.run_until_complete(async_main())
```
Have a look at the [example.py](https://github.com/cyr-ius/aiosysbus/blob/master/example.py) for a more complete overview.
## Notes on HTTPS
Not implemented
Raw data
{
"_id": null,
"home_page": null,
"name": "aiosysbus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "livebox, async",
"author": null,
"author_email": "Cyr-ius <cyr-ius@ipocus.net>",
"download_url": "https://files.pythonhosted.org/packages/65/ab/2cebf7fadb516b0de298c5b136fa8a19331561806ea967b9667463e5d13c/aiosysbus-1.1.8.tar.gz",
"platform": null,
"description": "# aiosysbus\n\nManage your Livebox in Python\n\nEasily manage your Livebox in Python.\nCheck your config, configure your dhcp, disable your wifi, monitor your LAN activity and many others, on LAN or remotely.\n\naiosysbus is a python library implementing fir the Livebox v3.\n\nThis project is based on stilllman/aiofreepybox, which provides the same features as aiofreepybox in a synchronous manner.\n\n## WARNING\n\n**Version 1.0.0 and above** makes all these calls asynchronously.\nIt breaks the compatibility of previous codes\n\n## Install\n\nUse the PIP package manager\n\n```bash\n$ pip install aiosysbus\n```\n\nOr manually download and install the last version from github\n\n```bash\n$ git clone https://github.com/cyr-ius/aiosysbus.git\n$ python setup.py install\n```\n\n## Get started\n\naiosysbus < 1.0.0\n\n```python\n# Import the aiosysbus package.\nfrom aiosysbus import AIOSysbus\n\nasync def reboot()\n # Instantiate the Sysbus class using default options.\n lvbx = AIOSysbus('192.168.1.1','80','xxxxxx')\n\n # Connect to the livebox with default options.\n lvbx.connect()\n\n # Do something useful, rebooting your livebox for example.\n lvbx.system.reboot()\n\n # Properly close the session.\n lvbx.close()\n```\n\naiosysbus >= 1.0.0\n\n```python\nimport asyncio\nimport logging\n\nasync def async_main() -> None:\n # Instantiate the Sysbus class using default options.\n api = AIOSysbus(username=xxxx, password=xxxx, host=HOST)\n # Connect to the livebox.\n await api.async_connect()\n # Query example\n parameters = {\"parameters\": {\"expression\": {\"wifi\": \"wifi && .Active==False\"}}}\n devices = await api.devices.async_get_devices(parameters)\n\n await api.async_close()\n\nif __name__ == \"__main__\":\n loop = asyncio.get_event_loop()\n loop.run_until_complete(async_main())\n```\n\nHave a look at the [example.py](https://github.com/cyr-ius/aiosysbus/blob/master/example.py) for a more complete overview.\n\n## Notes on HTTPS\n\nNot implemented\n",
"bugtrack_url": null,
"license": "GPL-3",
"summary": "Provides asynchronous authentication and access to Livebox",
"version": "1.1.8",
"project_urls": null,
"split_keywords": [
"livebox",
" async"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aad4377f16b75f0ee922d47844b3355e71c047e10739a81854e0a6e1b4ee616b",
"md5": "8cef9e0355b9ca2d9f3bb34a92664dc3",
"sha256": "9f160bae567ef5272a6e5837e717f8ec6cf3bc9724e606409acf3d118124bb4e"
},
"downloads": -1,
"filename": "aiosysbus-1.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8cef9e0355b9ca2d9f3bb34a92664dc3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 40193,
"upload_time": "2024-05-27T16:19:50",
"upload_time_iso_8601": "2024-05-27T16:19:50.074476Z",
"url": "https://files.pythonhosted.org/packages/aa/d4/377f16b75f0ee922d47844b3355e71c047e10739a81854e0a6e1b4ee616b/aiosysbus-1.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "65ab2cebf7fadb516b0de298c5b136fa8a19331561806ea967b9667463e5d13c",
"md5": "349558582d6f9e43998a91da7fccb452",
"sha256": "5f78d8047af5b7d13430571b8b7d8215fd0517a508b5e6f9608677578491a90d"
},
"downloads": -1,
"filename": "aiosysbus-1.1.8.tar.gz",
"has_sig": false,
"md5_digest": "349558582d6f9e43998a91da7fccb452",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 42459,
"upload_time": "2024-05-27T16:19:51",
"upload_time_iso_8601": "2024-05-27T16:19:51.882276Z",
"url": "https://files.pythonhosted.org/packages/65/ab/2cebf7fadb516b0de298c5b136fa8a19331561806ea967b9667463e5d13c/aiosysbus-1.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-27 16:19:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "aiosysbus"
}
