Imported from wifinity/python-tplink-omada (docs/AGENTS.md). Install upstream with npx skills add wifinity/python-tplink-omada --skill docs. Copyright stays with the author.

Agent guide — python-tplink-omada

Name: docs
Author: wifinity

What this repo is

Python client for the TP-Link Omada OpenAPI. Dict-first resource wrappers cover sites, devices, APs, switches, WLAN groups, Wi-Fi SSIDs, AP groups, LAN networks, RADIUS profiles, OLTs, and site services. Generated models stay internal. Does not own higher-level orchestration workflows or external system integrations — it is a thin controller-facing client only.

Package layout (`omada_client/`)

Path	Purpose
`omada_client/client.py`	`OmadaClient` — entry point and resource sub-clients
`omada_client/auth.py`	OAuth2 client credentials (`/openapi/authorize/token`)
`omada_client/config.py`	Client configuration
`omada_client/mac.py`	MAC validation/normalization (`AA-BB-CC-DD-EE-FF`)
`omada_client/exceptions.py`	`WLANGroupNotFoundError`, `DeviceNotFoundError`, `LanNetworkNotFoundError`, etc.
`omada_client/resources/`	Sites, devices, APs, switches, WLAN groups, Wi-Fi networks, AP groups, LAN networks, RADIUS profiles, OLTs, site services
`omada_client/generated/models/`	Internal OpenAPI-generated models (not public API)
`omada_client/wifi_payload_utils.py`	SSID create/update payload helpers

Repo root: tests/, docs/, spec/, tools/, Makefile, pyproject.toml.

Conventions

Public API is dict-first for ergonomics; generated models remain internal.
Public resource methods are keyword-only (def method(self, *, ...)).
MAC parameter name: mac — validated/normalized to uppercase hyphen EUI-48.
Site defaults on create/update: region="United Kingdom", scenario="Dormitory", time_zone/timezone="UTC".
Region input: full country name via pycountry; ISO codes rejected.
Spec workflow: fetch → patch (tools/fix_spec.py) → validate → make generate-models.

Where to look

ADR (single file): adr.md — numbered decisions (named params, MAC policy, Wi-Fi types, etc.)
Index: INDEX.md
Memory: .agents/memory/python-tplink-omada-repository-memory.md

Starting a new task

Read .agents/memory/python-tplink-omada-repository-memory.md.
Read relevant section in docs/adr.md for the change area.
Run make tests before opening a PR.

Testing

Full suite: make tests; spec pipeline: make spec-fix, make spec-validate, make generate-models.
Tests in tests/ with pytest; use pytest-httpx for HTTP behavior.

{ "ocm": "1", "id": "wifinity-python-tplink-omada-docs", "kind": "skill", "name": "docs", "description": "Python client for the TP-Link Omada OpenAPI. Dict-first resource wrappers cover sites, devices, APs, switches, WLAN groups, Wi-Fi SSIDs, AP groups, LAN networks, RADIUS profiles, OLTs, and site services. Generated models stay internal. Does **not** own higher-level orchestration workflows or external system integrations — it is a thin controller-facing client only.", "publisher": "wifinity", "version": "1.0.0", "capabilities": { "domains": [ "coding" ], "tags": [ "skill-md", "github-agents" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Python client for the TP-Link Omada OpenAPI. Dict-first resource wrappers cover sites, devices, APs, switches, WLAN groups, Wi-Fi SSIDs, AP groups, LAN networks, RADIUS profiles, OLTs, and site services. Generated models stay internal. Does **not** own higher-level orchestration workflows or external system integrations — it is a thin controller-facing client only." ], "primary": false, "metadata": { "source": { "provider": "github-agents", "repository": "https://github.com/wifinity/python-tplink-omada", "path": "docs/AGENTS.md", "ref": "fe3fcd27fbfe02e357fcf7c0e9534916df8dc251", "url": "https://github.com/wifinity/python-tplink-omada/blob/fe3fcd27fbfe02e357fcf7c0e9534916df8dc251/docs/AGENTS.md", "key": "wifinity/python-tplink-omada/docs/AGENTS.md" } }, "instructions": "# Agent guide — python-tplink-omada\n\n## What this repo is\n\nPython client for the TP-Link Omada OpenAPI. Dict-first resource wrappers cover\nsites, devices, APs, switches, WLAN groups, Wi-Fi SSIDs, AP groups, LAN networks,\nRADIUS profiles, OLTs, and site services. Generated models stay internal.\nDoes **not** own higher-level orchestration workflows or external system\nintegrations — it is a thin controller-facing client only.\n\n## Package layout (`omada_client/`)\n\n| Path | Purpose |\n|------|---------|\n| `omada_client/client.py` | `OmadaClient` — entry point and resource sub-clients |\n| `omada_clie", "cost": { "context_tokens": 636 } }

docs

About

Agent guide — python-tplink-omada

What this repo is

Package layout (`omada_client/`)

Conventions

Where to look

Starting a new task

Testing

Use it

Manifest

Reviews

About

Agent guide — python-tplink-omada

What this repo is

Package layout (omada_client/)

Conventions

Where to look

Starting a new task

Testing

Use it

Manifest

Reviews

Package layout (`omada_client/`)