# TendaEverest
Python package to manage Tenda Everest router
You can find **Full Project Documentation** [here][documentation_path]
<hr>
#### Workflows
[![Tests](https://github.com/quillcraftsman/tenda-everest/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/quillcraftsman/tenda-everest/actions/workflows/run-tests.yml)
[![Pylint](https://github.com/quillcraftsman/tenda-everest/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/quillcraftsman/tenda-everest/actions/workflows/lint.yml)
#### Package
[![Version](https://img.shields.io/pypi/v/tenda-everest.svg)](https://pypi.python.org/pypi/tenda-everest/)
[![Development Status](https://img.shields.io/pypi/status/tenda-everest.svg)](https://pypi.python.org/pypi/tenda-everest)
[![Python version](https://img.shields.io/pypi/pyversions/tenda-everest.svg)](https://pypi.python.org/pypi/tenda-everest/)
[![License](https://img.shields.io/pypi/l/tenda-everest)](https://github.com/quillcraftsman/tenda-everest/blob/main/LICENSE)
[![Wheel](https://img.shields.io/pypi/wheel/tenda-everest.svg)](https://pypi.python.org/pypi/tenda-everest/)
#### Support
[![Documentation](https://img.shields.io/badge/docs-0094FF.svg)][documentation_path]
[![Discussions](https://img.shields.io/badge/discussions-ff0068.svg)](https://github.com/quillcraftsman/tenda-everest/discussions/)
[![Issues](https://img.shields.io/badge/issues-11AE13.svg)](https://github.com/quillcraftsman/tenda-everest/issues/)
#### Downloads
[![Day Downloads](https://img.shields.io/pypi/dd/tenda-everest)](https://pepy.tech/project/tenda-everest)
[![Week Downloads](https://img.shields.io/pypi/dw/tenda-everest)](https://pepy.tech/project/tenda-everest)
[![Month Downloads](https://img.shields.io/pypi/dm/tenda-everest)](https://pepy.tech/project/tenda-everest)
[![All Downloads](https://img.shields.io/pepy/dt/tenda-everest)](https://pepy.tech/project/tenda-everest)
#### Languages
[![Languages](https://img.shields.io/github/languages/count/quillcraftsman/tenda-everest)](https://github.com/quillcraftsman/tenda-everest)
[![Top Language](https://img.shields.io/github/languages/top/quillcraftsman/tenda-everest)](https://github.com/quillcraftsman/tenda-everest)
#### Development
- [![Release date](https://img.shields.io/github/release-date/quillcraftsman/tenda-everest
)](https://github.com/quillcraftsman/tenda-everest/releases)
[![Last Commit](https://img.shields.io/github/last-commit/quillcraftsman/tenda-everest/main
)](https://github.com/quillcraftsman/tenda-everest)
- [![Issues](https://img.shields.io/github/issues/quillcraftsman/tenda-everest
)](https://github.com/quillcraftsman/tenda-everest/issues/)
[![Closed Issues](https://img.shields.io/github/issues-closed/quillcraftsman/tenda-everest
)](https://github.com/quillcraftsman/tenda-everest/issues/)
- [![Pull Requests](https://img.shields.io/github/issues-pr/quillcraftsman/tenda-everest
)](https://github.com/quillcraftsman/tenda-everest/pulls)
[![Closed Pull Requests](https://img.shields.io/github/issues-pr-closed-raw/quillcraftsman/tenda-everest
)](https://github.com/quillcraftsman/tenda-everest/pulls)
- [![Discussions](https://img.shields.io/github/discussions/quillcraftsman/tenda-everest
)](https://github.com/quillcraftsman/tenda-everest/discussions/)
[//]: # (#### Repository Stats)
[//]: # ([![Stars](https://img.shields.io/github/stars/quillcraftsman/tenda-everest)
[//]: # ()](https://github.com/quillcraftsman/tenda-everest))
[//]: # ([![Contributors](https://img.shields.io/github/contributors/quillcraftsman/tenda-everest)
[//]: # ()](https://github.com/quillcraftsman/tenda-everestgraphs/contributors))
[//]: # ([![Forks](https://img.shields.io/github/forks/quillcraftsman/tenda-everest)
[//]: # ()](https://github.com/quillcraftsman/tenda-everest))
<hr>
## Menu
- [Mission](#mission)
- [Open Source Project](#open-source-project)
- [Features](#features)
- [Requirements](#requirements)
- [Development Status](#development-status)
- [Install](#install)
- [Quickstart](#quickstart)
- [Contributing](#contributing)
## Mission
`tenda-everest` is python package to manage Tenda Everest router.
This package was tested on **EVEREST EWR-F303** Wireless Router with **Tenda** firmware **V02.03.01.125**.
It also works with **V12.01.01.33_multi** and **V12.01.01.32_multi** but may be with some problems.
It could work with other similar firmwares.
But this package may work on different routers with other firmwares.
![Everest ewr-f303 router picture](https://github.com/quillcraftsman/tenda-everest/blob/main/everest.jpeg)
## Open Source Project
This is the open source project with [MIT license](LICENSE).
Be free to use, fork, clone and contribute.
## Features
- Connect to router by web interface (DONE)
- Get all information from router (like wi-fi settings, firmware, and all others) (DONE)
- Mange router (turn on wps, add port forwarding, ...) (PLAN)
## Requirements
- requests
- See more in [Full Documentation](https://quillcraftsman.github.io/tenda-everest/about.html#requirements)
## Development Status
- Package already available on [PyPi](https://pypi.org/project/tenda-everest/)
- See more in [Full Documentation](https://quillcraftsman.github.io/tenda-everest/about.html#development-status)
## Install
### with pip
```commandline
pip install tenda-everest
```
See more in [Full Documentation](https://quillcraftsman.github.io/tenda-everest/install.html)
## Quickstart
```python
import pprint
import requests
from tenda_everest import login, get_info, MODULES, request_firmware
host = 'http://192.168.0.1:8081' # There is device located
session = login(requests, host) # connect to device and login
firmware = request_firmware(host, session) # check router firmware
print(firmware)
modules = ( # What do you want to know
MODULES.systemInfo,
MODULES.wanBasicCfg,
MODULES.wifiBasicCfg,
MODULES.softWare,
)
info = get_info(host, session, modules, firmware=firmware)
pprint.pprint(info)
```
### More examples in [Full Documentation][documentation_path]
## Contributing
You are welcome! To easy start please check:
- [Full Documentation][documentation_path]
- [Contributing](CONTRIBUTING.md)
- [Developer Documentation](https://quillcraftsman.github.io/tenda-everest/dev_documentation.html)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Security Policy](SECURITY.md)
- [Governance](GOVERNANCE.md)
- [Support](SUPPORT.md)
[documentation_path]: https://quillcraftsman.github.io/tenda-everest
Raw data
{
"_id": null,
"home_page": "https://github.com/quillcraftsman/tenda-everest",
"name": "tenda-everest",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "python, package, everest, tenda, router, manage",
"author": "quillcraftsman",
"author_email": "quill@craftsman.lol",
"download_url": "https://files.pythonhosted.org/packages/92/a4/88c0638dc0cb5f3011e5e35b9ae2494c399d5b92c0b852dd4371195d634a/tenda_everest-0.3.1.tar.gz",
"platform": null,
"description": "# TendaEverest\n\nPython package to manage Tenda Everest router\n\nYou can find **Full Project Documentation** [here][documentation_path]\n\n<hr>\n\n#### Workflows\n[![Tests](https://github.com/quillcraftsman/tenda-everest/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/quillcraftsman/tenda-everest/actions/workflows/run-tests.yml)\n[![Pylint](https://github.com/quillcraftsman/tenda-everest/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/quillcraftsman/tenda-everest/actions/workflows/lint.yml)\n\n#### Package\n[![Version](https://img.shields.io/pypi/v/tenda-everest.svg)](https://pypi.python.org/pypi/tenda-everest/)\n[![Development Status](https://img.shields.io/pypi/status/tenda-everest.svg)](https://pypi.python.org/pypi/tenda-everest)\n[![Python version](https://img.shields.io/pypi/pyversions/tenda-everest.svg)](https://pypi.python.org/pypi/tenda-everest/)\n[![License](https://img.shields.io/pypi/l/tenda-everest)](https://github.com/quillcraftsman/tenda-everest/blob/main/LICENSE)\n[![Wheel](https://img.shields.io/pypi/wheel/tenda-everest.svg)](https://pypi.python.org/pypi/tenda-everest/)\n\n#### Support\n[![Documentation](https://img.shields.io/badge/docs-0094FF.svg)][documentation_path]\n[![Discussions](https://img.shields.io/badge/discussions-ff0068.svg)](https://github.com/quillcraftsman/tenda-everest/discussions/)\n[![Issues](https://img.shields.io/badge/issues-11AE13.svg)](https://github.com/quillcraftsman/tenda-everest/issues/)\n\n#### Downloads\n[![Day Downloads](https://img.shields.io/pypi/dd/tenda-everest)](https://pepy.tech/project/tenda-everest)\n[![Week Downloads](https://img.shields.io/pypi/dw/tenda-everest)](https://pepy.tech/project/tenda-everest)\n[![Month Downloads](https://img.shields.io/pypi/dm/tenda-everest)](https://pepy.tech/project/tenda-everest)\n[![All Downloads](https://img.shields.io/pepy/dt/tenda-everest)](https://pepy.tech/project/tenda-everest)\n\n#### Languages\n[![Languages](https://img.shields.io/github/languages/count/quillcraftsman/tenda-everest)](https://github.com/quillcraftsman/tenda-everest)\n[![Top Language](https://img.shields.io/github/languages/top/quillcraftsman/tenda-everest)](https://github.com/quillcraftsman/tenda-everest)\n\n#### Development\n- [![Release date](https://img.shields.io/github/release-date/quillcraftsman/tenda-everest\n)](https://github.com/quillcraftsman/tenda-everest/releases)\n[![Last Commit](https://img.shields.io/github/last-commit/quillcraftsman/tenda-everest/main\n)](https://github.com/quillcraftsman/tenda-everest)\n- [![Issues](https://img.shields.io/github/issues/quillcraftsman/tenda-everest\n)](https://github.com/quillcraftsman/tenda-everest/issues/)\n[![Closed Issues](https://img.shields.io/github/issues-closed/quillcraftsman/tenda-everest\n)](https://github.com/quillcraftsman/tenda-everest/issues/)\n- [![Pull Requests](https://img.shields.io/github/issues-pr/quillcraftsman/tenda-everest\n)](https://github.com/quillcraftsman/tenda-everest/pulls)\n[![Closed Pull Requests](https://img.shields.io/github/issues-pr-closed-raw/quillcraftsman/tenda-everest\n)](https://github.com/quillcraftsman/tenda-everest/pulls)\n- [![Discussions](https://img.shields.io/github/discussions/quillcraftsman/tenda-everest\n)](https://github.com/quillcraftsman/tenda-everest/discussions/)\n\n[//]: # (#### Repository Stats)\n\n[//]: # ([![Stars](https://img.shields.io/github/stars/quillcraftsman/tenda-everest)\n\n[//]: # ()](https://github.com/quillcraftsman/tenda-everest))\n\n[//]: # ([![Contributors](https://img.shields.io/github/contributors/quillcraftsman/tenda-everest)\n\n[//]: # ()](https://github.com/quillcraftsman/tenda-everestgraphs/contributors))\n\n[//]: # ([![Forks](https://img.shields.io/github/forks/quillcraftsman/tenda-everest)\n\n[//]: # ()](https://github.com/quillcraftsman/tenda-everest))\n\n<hr>\n\n## Menu\n\n- [Mission](#mission)\n- [Open Source Project](#open-source-project)\n- [Features](#features)\n- [Requirements](#requirements)\n- [Development Status](#development-status)\n- [Install](#install)\n- [Quickstart](#quickstart)\n- [Contributing](#contributing)\n\n## Mission\n\n`tenda-everest` is python package to manage Tenda Everest router.\n\nThis package was tested on **EVEREST EWR-F303** Wireless Router with **Tenda** firmware **V02.03.01.125**. \nIt also works with **V12.01.01.33_multi** and **V12.01.01.32_multi** but may be with some problems.\nIt could work with other similar firmwares.\nBut this package may work on different routers with other firmwares.\n\n![Everest ewr-f303 router picture](https://github.com/quillcraftsman/tenda-everest/blob/main/everest.jpeg)\n\n## Open Source Project\n\nThis is the open source project with [MIT license](LICENSE). \nBe free to use, fork, clone and contribute.\n\n## Features\n\n- Connect to router by web interface (DONE)\n- Get all information from router (like wi-fi settings, firmware, and all others) (DONE)\n- Mange router (turn on wps, add port forwarding, ...) (PLAN)\n\n## Requirements\n\n- requests\n- See more in [Full Documentation](https://quillcraftsman.github.io/tenda-everest/about.html#requirements)\n\n## Development Status\n\n- Package already available on [PyPi](https://pypi.org/project/tenda-everest/)\n- See more in [Full Documentation](https://quillcraftsman.github.io/tenda-everest/about.html#development-status)\n\n## Install\n\n### with pip\n\n```commandline\npip install tenda-everest\n```\n\nSee more in [Full Documentation](https://quillcraftsman.github.io/tenda-everest/install.html)\n\n## Quickstart\n\n```python\nimport pprint\nimport requests\nfrom tenda_everest import login, get_info, MODULES, request_firmware \n\nhost = 'http://192.168.0.1:8081' # There is device located\n\nsession = login(requests, host) # connect to device and login\n\nfirmware = request_firmware(host, session) # check router firmware\nprint(firmware)\n\nmodules = ( # What do you want to know\n MODULES.systemInfo,\n MODULES.wanBasicCfg,\n MODULES.wifiBasicCfg,\n MODULES.softWare,\n)\n\ninfo = get_info(host, session, modules, firmware=firmware)\n\npprint.pprint(info)\n```\n\n### More examples in [Full Documentation][documentation_path]\n\n## Contributing\n\nYou are welcome! To easy start please check:\n- [Full Documentation][documentation_path]\n- [Contributing](CONTRIBUTING.md)\n- [Developer Documentation](https://quillcraftsman.github.io/tenda-everest/dev_documentation.html)\n- [Code of Conduct](CODE_OF_CONDUCT.md)\n- [Security Policy](SECURITY.md)\n- [Governance](GOVERNANCE.md)\n- [Support](SUPPORT.md)\n\n[documentation_path]: https://quillcraftsman.github.io/tenda-everest\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python package to manage Tenda Everest router",
"version": "0.3.1",
"project_urls": {
"Changelog": "https://github.com/quillcraftsman/tenda-everest/releases",
"Documentation": "https://quillcraftsman.github.io/tenda-everest",
"Download": "https://pypi.org/project/tenda-everest/",
"Homepage": "https://github.com/quillcraftsman/tenda-everest",
"Release notes": "https://github.com/quillcraftsman/tenda-everest/releases",
"Source": "https://github.com/quillcraftsman/tenda-everest",
"Tracker": "https://github.com/quillcraftsman/tenda-everest/issues"
},
"split_keywords": [
"python",
" package",
" everest",
" tenda",
" router",
" manage"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06d3a2355a9284eff0491ddf79c4b027925985c27cc625263909a21fdaa8cd15",
"md5": "9a2be12da9c9f287a37a93eda0499bbe",
"sha256": "c19d5d65f8f9b108ab63ae6903bab30b1a544b6ea31cf37c1e7b997c5e42aadc"
},
"downloads": -1,
"filename": "tenda_everest-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a2be12da9c9f287a37a93eda0499bbe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 6005,
"upload_time": "2024-09-18T08:05:33",
"upload_time_iso_8601": "2024-09-18T08:05:33.535339Z",
"url": "https://files.pythonhosted.org/packages/06/d3/a2355a9284eff0491ddf79c4b027925985c27cc625263909a21fdaa8cd15/tenda_everest-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "92a488c0638dc0cb5f3011e5e35b9ae2494c399d5b92c0b852dd4371195d634a",
"md5": "1170f9cfc2737575a9ea9558884a1333",
"sha256": "75b49ef752dc89ef1ed00ca378cf8396e0c82f5d331114c58d3516485b5b474b"
},
"downloads": -1,
"filename": "tenda_everest-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "1170f9cfc2737575a9ea9558884a1333",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 6395,
"upload_time": "2024-09-18T08:05:34",
"upload_time_iso_8601": "2024-09-18T08:05:34.416444Z",
"url": "https://files.pythonhosted.org/packages/92/a4/88c0638dc0cb5f3011e5e35b9ae2494c399d5b92c0b852dd4371195d634a/tenda_everest-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 08:05:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "quillcraftsman",
"github_project": "tenda-everest",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "tenda-everest"
}