Metadata-Version: 2.4
Name: aioopnsense
Version: 0.1.0
Summary: Async Python client for the OPNsense API
Author: kisst
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/kisst/aioopnsense
Project-URL: Repository, https://github.com/kisst/aioopnsense
Project-URL: Issues, https://github.com/kisst/aioopnsense/issues
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Home Automation
Classifier: Topic :: System :: Networking
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp>=3.9.0
Dynamic: license-file

# aioopnsense

Async Python client for the OPNsense API, compatible with OPNsense 25.7+.

Uses the snake_case API endpoints introduced in OPNsense 25.7.

## Installation

```bash
pip install aioopnsense
```

## Usage

```python
import aiohttp
from aioopnsense import OPNsenseClient

async with aiohttp.ClientSession() as session:
    client = OPNsenseClient(
        url="https://opnsense.local/api",
        api_key="your_api_key",
        api_secret="your_api_secret",
        session=session,
    )

    # Get ARP table
    arp_table = await client.get_arp()

    # Get network interfaces
    interfaces = await client.get_interfaces()
```

## Supported Endpoints

- `GET /api/diagnostics/interface/get_arp` - ARP table
- `GET /api/diagnostics/networkinsight/get_interfaces` - Network interfaces

## License

Apache-2.0
