Skip to main content

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

Project description

gli4py

A aysnc python 3 API wrapper for GL-inet routers with version 4 firmware. [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

gli4py-0.0.7.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

gli4py-0.0.7-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file gli4py-0.0.7.tar.gz.

File metadata

  • Download URL: gli4py-0.0.7.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.8 Linux/5.15.153.1-microsoft-standard-WSL2

File hashes

Hashes for gli4py-0.0.7.tar.gz
Algorithm Hash digest
SHA256 ed49e6436c62351eb016e6f0f48bb891742852a69309f024c235be902a8026fe
MD5 441d76059296d8891c912158ef67df84
BLAKE2b-256 b475cc1d08b860f750eab8245acb03a65f18eb7fcc2097e2bbf5f00135b77403

See more details on using hashes here.

File details

Details for the file gli4py-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: gli4py-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.8 Linux/5.15.153.1-microsoft-standard-WSL2

File hashes

Hashes for gli4py-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f099169cbe50d595783c47abc875f675de9587112dcff574b13729d59bea5c63
MD5 cbb658ec0c7d789e0b4faf2af234a18a
BLAKE2b-256 1fd28e4b61031d5d1309611e8ef6a2e45c8917aa21cf442c606b8fbad65ed620

See more details on using hashes here.

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