KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #ai-agents #dsh-plugin #codex #developer-tools #claude-code #windows #desktop-app #typescript #rust #ai-agent #cli

python-glinet

★ 32 Open GitHub ↗

Python3 GL-Inet client for json-rpc

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![GitHub Workflow Status
(event)](https://img.shields.io/github/actions/workflow/status/tomtana/python-glinet/python-tests.yml?branch=main&label=tests)](https://github.com/tomtana/python-glinet/actions/workflows/python-tests.yml)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/tomtana/python-glinet/build_deploy_pages.yml?branch=main&label=docs)](https://tomtana.github.io/python-glinet/)
[![PyPI - Python
Version](https://img.shields.io/pypi/pyversions/python-glinet)](https://pypi.org/project/python-glinet)
[![PyPI](https://img.shields.io/pypi/v/python-glinet)](https://pypi.org/project/python-glinet)
[![Code
Cov](https://codecov.io/gh/tomtana/python-glinet/branch/main/graph/badge.svg?token=976L8ESH8K)](https://codecov.io/gh/tomtana/python-glinet)

# 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.

![python-glinet demonstration](https://github.com/tomtana/python-glinet/raw/main/resources/python_glinet_demo.gif)

## 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):

``` bash
pip install python-glinet
```

From source for development:

``` bash
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](https://docs.python.org/3/tutorial/venv.html)
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](https://tomtana.github.io/python-glinet/glinet.html).

``` python
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:

``` python
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:

``` python
api_client
```

Explore methods:

``` python
api_client.wg_client
```

View parameters:

``` python
api_client.wg_client.set_config
```

Docstring:

``` python
api_client.wg_client.set_config?
```

Call method:

``` python
api_client.wg_client.get_all_config_list()
```

Responses are objects for easy access.

### Direct Requests

``` python
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
-   \[ \] Cli wrapper

## Contributing

Welcome contributions! Fork, branch, and PR on
[GitHub](https://github.com/tomtana/python-glinet). Test changes and
follow roadmap.

For issues, use [GitHub
Issues](https://github.com/tomtana/python-glinet/issues).

## License

MIT License. See
[LICENSE](https://github.com/tomtana/python-glinet/blob/main/LICENSE).

python-glinet

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README