## PyAsusWrt
**PyAsusWrt** is a small API wrapper written in python for communication with ASUSWRT-powered routers using the
HTTP or HTTPS protocols.
It is based on Asynchronous HTTP Client [AioHTTP](https://docs.aiohttp.org/en/stable/).
It was mainly developed to be used with HomeAssistant AsusWRT integration as an alternative to the excellent library
currently in use [AIOAsusWrt](https://github.com/kennedyshead/aioasuswrt). The purpose of this library is not to replace
AIOAsusWrt (which uses the `SSH` and `Telnet` protocols) but to work alongside it to allow also the use the HTTP(s) protocols,
so you can choose the best solution according to your model of router.
Of course, you can use this library for any other purpose, respecting the open source license to which this library is licensed.
### Note
Pull Request to HA integration is under development and will be available **when and if** it will be approved by HA teams.
If you cannot wait for the completion of the PR, it is possible to replace the native HA integration with
[this custom integration](https://github.com/ollo69/ha_asuswrt_custom) that already contains support for this new library.
This custom integration is based on the native one and is to be considered for test purpose only.
## Installation
Installation of the latest release is available from PyPI:
```
pip install pyasuswrt
```
## How open issue and run tests
There are many versions of `asuswrt` firmware, sometimes they just don't work in current implementation.
If you have a problem with your specific router open an issue on this repository, but please add as much info as you can and
at least:
* Model and version of router
* Version of Asuswrt
If possible before open issue run a test on your environment, using the code inside the module `test.py` (you must set
right login credential inside the module before running it) and then provide the error log printed by the test.
To run the test:
```
python test.py
```
## Be nice!
If you like the library, why don't you support me by buying me a coffee?
It would certainly motivate me to further improve this work.
[](https://www.buymeacoffee.com/ollo69)
Raw data
{
"_id": null,
"home_page": "https://github.com/ollo69/pyasuswrt",
"name": "pyasuswrt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "asuswrt,asuswrt wrapper",
"author": "ollo69",
"author_email": "ollo69@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/ad/09/15df06dd173863b224a9b61861110db5caae26b4f9c78077d64b6cc593c7/pyasuswrt-0.1.21.tar.gz",
"platform": null,
"description": "## PyAsusWrt\r\n\r\n**PyAsusWrt** is a small API wrapper written in python for communication with ASUSWRT-powered routers using the \r\nHTTP or HTTPS protocols.\r\n\r\nIt is based on Asynchronous HTTP Client [AioHTTP](https://docs.aiohttp.org/en/stable/).\r\n\r\nIt was mainly developed to be used with HomeAssistant AsusWRT integration as an alternative to the excellent library \r\ncurrently in use [AIOAsusWrt](https://github.com/kennedyshead/aioasuswrt). The purpose of this library is not to replace \r\nAIOAsusWrt (which uses the `SSH` and `Telnet` protocols) but to work alongside it to allow also the use the HTTP(s) protocols, \r\nso you can choose the best solution according to your model of router.\r\n\r\nOf course, you can use this library for any other purpose, respecting the open source license to which this library is licensed.\r\n\r\n### Note\r\n\r\nPull Request to HA integration is under development and will be available **when and if** it will be approved by HA teams.\r\n\r\nIf you cannot wait for the completion of the PR, it is possible to replace the native HA integration with \r\n[this custom integration](https://github.com/ollo69/ha_asuswrt_custom) that already contains support for this new library.\r\nThis custom integration is based on the native one and is to be considered for test purpose only.\r\n\r\n\r\n## Installation\r\n\r\nInstallation of the latest release is available from PyPI:\r\n\r\n```\r\npip install pyasuswrt\r\n```\r\n\r\n## How open issue and run tests\r\nThere are many versions of `asuswrt` firmware, sometimes they just don't work in current implementation.\r\nIf you have a problem with your specific router open an issue on this repository, but please add as much info as you can and \r\nat least:\r\n\r\n* Model and version of router\r\n* Version of Asuswrt\r\n\r\nIf possible before open issue run a test on your environment, using the code inside the module `test.py` (you must set\r\nright login credential inside the module before running it) and then provide the error log printed by the test.\r\n\r\nTo run the test:\r\n\r\n```\r\npython test.py\r\n```\r\n\r\n## Be nice!\r\nIf you like the library, why don't you support me by buying me a coffee?\r\nIt would certainly motivate me to further improve this work.\r\n\r\n[](https://www.buymeacoffee.com/ollo69)\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Api wrapper for Asuswrt https://www.asus.com/ASUSWRT/ using protocol HTTP",
"version": "0.1.21",
"project_urls": {
"Download": "https://github.com/ollo69/pyasuswrt/archive/0.1.21.tar.gz",
"Homepage": "https://github.com/ollo69/pyasuswrt"
},
"split_keywords": [
"asuswrt",
"asuswrt wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bbe8de26161a972a73644dd8a0271e4ea0de662739f976e7f34c5e69b78a7373",
"md5": "62be291b76426b348679303cacb7743b",
"sha256": "1a1da5f878868c97150e01303c8a246e1fb1f5142589da54f111425d879f4058"
},
"downloads": -1,
"filename": "pyasuswrt-0.1.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "62be291b76426b348679303cacb7743b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 14348,
"upload_time": "2023-12-17T18:35:50",
"upload_time_iso_8601": "2023-12-17T18:35:50.090461Z",
"url": "https://files.pythonhosted.org/packages/bb/e8/de26161a972a73644dd8a0271e4ea0de662739f976e7f34c5e69b78a7373/pyasuswrt-0.1.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ad0915df06dd173863b224a9b61861110db5caae26b4f9c78077d64b6cc593c7",
"md5": "7e2333074e75274cef57730d8e298169",
"sha256": "ffee28f789512eea42ce182ba6a89fa2f5a31a423daf4fdcf6bad48a813a196f"
},
"downloads": -1,
"filename": "pyasuswrt-0.1.21.tar.gz",
"has_sig": false,
"md5_digest": "7e2333074e75274cef57730d8e298169",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 15484,
"upload_time": "2023-12-17T18:35:51",
"upload_time_iso_8601": "2023-12-17T18:35:51.375460Z",
"url": "https://files.pythonhosted.org/packages/ad/09/15df06dd173863b224a9b61861110db5caae26b4f9c78077d64b6cc593c7/pyasuswrt-0.1.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-17 18:35:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ollo69",
"github_project": "pyasuswrt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyasuswrt"
}
JSON
