python-glinet 0.8.1

Python3 client for Gl.Inet LUCI API firmware 4.0 onwards.

python-glinet: Python 3 Client for GL.iNet Routers

Introduction

python-glinet is a robust Python 3 library for interacting with GL.iNet router's LuCI API on firmware 4.x and later. It enables developers to programmatically manage and configure GL.iNet routers with features like dynamic API method generation, object-oriented response parsing, and automated session maintenance. Ideal for automation scripts and integrations, it supports interactive exploration via IPython.

Features

• Comprehensive API Coverage: Full access to LuCI API endpoints for firmware 4.x+.
• Dynamic Methods: Auto-generates methods with docstrings from API documentation.
• Intuitive Responses: Converts JSON responses to objects for dot-notation access.
• Session Handling: Background thread for connection persistence; cached credentials.
• Interactive Support: Optimized for IPython with code completion and docstrings.

[!NOTE]

• Supports firmware 4.x+ only, following GL.iNet's JSON-RPC transition.
• Uses archived API snapshot from Internet Archive .

Installation

Via pip (recommended in a virtual environment):

pip install python-glinet

From source for development:

git clone https://github.com/tomtana/python-glinet.git
cd python-glinet
python3 -m venv venv
source venv/bin/activate
pip install -e .

See Python's venv guide for details on virtual environments.

Quick Start

The GlInet class manages authentication and API interactions. Customize defaults (e.g., IP, username) via constructor parameters. Refer to class docs.

from pyglinet import GlInet
glinet = GlInet().login()  # Instantiates and logs in

[!WARNING] Do not pass passwords in code; use persistence or prompts for security.

[!NOTE]

• Loads API description from cache or online.
• login() handles credentials and starts session keeper.

API Usage

Dynamic Client

In IPython, after login:

api_client = glinet.get_api_client()

• Structure: api_client.<group>.<method>
• Naming: Hyphens replaced with underscores (e.g., wg_client).
• Navigation: Use tab completion and ? for docstrings.

Examples

List groups:

api_client

Explore methods:

api_client.wg_client

View parameters:

api_client.wg_client.set_config

Docstring:

api_client.wg_client.set_config?

Call method:

api_client.wg_client.get_all_config_list()

Responses are objects for easy access.

Direct Requests

glinet.request("call", ["adguardhome", "get_config"])

Equivalent to api_client.adguardhome.get_config(), but returns full response.

Roadmap

• [x] Dynamic docstrings
• [x] PyPI package
• [x] Tests and coverage
• [x] Windows compatibility
• [ ] Terminal wrapper

Contributing

Welcome contributions! Fork, branch, and PR on GitHub. Test changes and follow roadmap.

For issues, use GitHub Issues.

License

MIT License. See LICENSE.