python-glinet 0.1.6

This package gives client access to the Gl-Inet json-rpc for firmware >=4.0

python-glinet - A Python3 client for GL-Inet Router

This package aims to provide full access to the GL-Inet Luci API for firmware versions >= 4.0 via json-rpc.

There is no official English documentation of the API yet. The lib parses the Chinese documentation from here and dynamically creates the functions.

The best way to navigate through the api is within an ipython shell. A wrapper is on the roadmap, but for now you must start ipython first and then load the module. Of course you can build your own application around, just bear in mind that the api function calls are generated on the fly.

My original use case was to automatically generate and write nordvpn wireguard configs to the router but then found an elegant way to autogenerate calls for the whole api and it got out of hand :).

Features

• Complete API support
• Dynamic method creation inclusive docstring from online documentation
• Api responses are represented recursively as objects, such that you can access all properties via '.'
• Cache for api description and hashed login
• Configure background thread to keep connection alive

Installation:

PiP

pip install python-glinet

Clone Repo

#clone repository
git clone https://github.com/tomtana/python-glinet.git
cd python-glinet

Install package directly. The -e parameter lets you edit the files. If this is not needed to can also install without the -e parameter.

pip install -e .

Alternatively install it in an Python virtual environment (see here for more infos)

python3 -m venv venv
source venv/bin/activate
pip install -e .

Examples:

Login

Login is as easy as that. If you modified your ip-address or other parameter, you need to pass them as parameter (see the documentation of the GlInet class for more details).

Per default the following steps are executed:

• if no password is passed
  • try to load from persistance (password stored as hash)
  • if no success ask via prompt
• try to load api reference from persistence, otherwise load it from the web
• persist settings
• start background thread to keep connection alive

from pyglinet import GlInet
glinet = GlInet()
glinet.login()

API usage

First you need to generate an api object.

client = glinet.get_api_client()

Now you can intuitively navigate the api using code completion and docstring.

ToDos:

• Add dynamically docstring for API calls
• Create pip compliant package
• Publish pip package
• Add tests
• Improve documentation
• Add wrapper for execution via terminal