glinet4

Quickstart

import asyncio

from glinet4 import GLinet


async def main() -> None:
    async with GLinet("http://192.168.8.1/rpc") as router:
        await router.login("root", "your-router-password")
        info = await router.router_info()
        print(info["model"], info["firmware_version"])


asyncio.run(main())

Swap in your router's host, username and password. login() must succeed before any other call — see API coverage below for the full method list, and CONTRIBUTING.md for how the test suite talks to a live router.

An async Python 3 API wrapper for GL.iNet routers running version 4.x firmware.

GL.iNet routers are built on OpenWRT and expose a local JSON-RPC API. glinet4 wraps that API for easy integration into other services such as Home Assistant.

glinet4 began as a fork of HarvsG/gli4py (GPL-3.0) and has since grown a much larger API surface. See NOTICE for attribution.

Installation

pip install glinet4

Dev setup

1. Clone the repo
2. Ensure you have Python 3.11 or greater (python3 -V) and install uv.
3. uv sync — creates the in-project .venv and installs the runtime + dev dependencies.
4. uvx prek install — sets up the git pre-commit hooks (ruff, mypy, file hygiene). Run them on demand with uvx prek run --all-files.
5. The tests run against a live router, so copy .env.example to .env and set at least GLINET_PASSWORD (and GLINET_HOST if not 192.168.8.1). Without it the live suite is skipped.
6. uv run pytest -s to see responses.
7. Build with uv build. Releases publish to PyPI automatically on a GitHub Release (trusted publishing).

See CONTRIBUTING.md for the full contributor flow: running the live suite safely, the pre-commit/CI gates, and how to submit a device capture.

API coverage

Session: login, router_reachable. All other methods require login first.

Responses are typed with TypedDicts (see glinet4/_types.py); the package ships py.typed. The catalogue of routes still to wrap comes from the sanitised device captures submitted to glinet4-registry — run uvx glinet4-profiler against your own router to contribute one.

Todo list:

• Decide on useful endpoints to expose
• Expose said endpoints (ongoing — see the table above and glinet4/glinet4 issues)
• Package correctly
• Test that dev enviroment is re-producable
• Publish on pip
• Static typing

Versioning & stability

glinet4 is pre-1.0: breaking changes can land in a minor version bump, not just a major one. CHANGELOG.md (generated by release-please from conventional commits) is the authoritative record of what changed in each release — check it before upgrading.

Part of the glinet4 project — glinet4 (Python library) · glinet4-ha (Home Assistant) · glinet4-profiler · glinet4-registry