Skip to main content

A python 3 API wrapper for GL-inet routers for consumption by Home Assistant

Project description

gli_py

A aysnc python 3 API wrapper for GL-inet routers. [WIP]

GL-inet routers are built on OpenWRT. They are highly customizeable but have an attractive user interface.

As part of their modiification of the UI they provide a locally accessible API.

I thought it would be handy to develop a python 3 wrapper for the API for easy intergation into other services such as HomeAssistant

Installation

pip3 install gli-py

Dev setup

  1. Clone the repo
  2. Ensure you have python 3 installed python3 -V or python -V
  3. Uses poetry for venv control pip3 install poetry
  4. poetry config virtualenvs.in-project true create the venvs in the project folder
  5. poetry install
  6. poetry shell
  7. To run tests, ensure there is a file called router_pwd in the root directory with the router password in.
  8. Then run pytest -s to see responses, assumes the router is at 192.168.0.1
  9. Set token with poetry config pypi-token.pypi TOKEN
  10. publish with poetry publish

Todo list:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gli_py-0.0.18.tar.gz (16.9 kB view hashes)

Uploaded Source

Built Distribution

gli_py-0.0.18-py3-none-any.whl (17.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page