quicnz 0.1.0__tar.gz

quicnz-0.1.0/.gitignore

@@ -0,0 +1,48 @@
+weathermap.jpg
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.pyd
+
+# Distribution / packaging
+.Python
+build/
+dist/
+*.egg-info/
+*.egg
+.eggs/
+wheels/
+pip-wheel-metadata/
+MANIFEST
+
+# Virtual environments
+.venv/
+venv/
+env/
+.env
+
+# Type checking
+.mypy_cache/
+.pytype/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Ruff
+.ruff_cache/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db

quicnz-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 quicnz contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

quicnz-0.1.0/PKG-INFO

@@ -0,0 +1,191 @@
+Metadata-Version: 2.4
+Name: quicnz
+Version: 0.1.0
+Summary: Async Python library for the Quic broadband API (unofficial, not affiliated with Quic Broadband / Vetta Trading Ltd)
+Project-URL: Homepage, https://github.com/quicnz/quicnz
+Project-URL: Repository, https://github.com/quicnz/quicnz
+Project-URL: Issues, https://github.com/quicnz/quicnz/issues
+Author: Aurélien Geron
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,broadband,nz,quic
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.9
+Provides-Extra: dev
+Requires-Dist: aioresponses>=0.7; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# quicnz
+
+Async Python library for the [Quic broadband](https://quic.nz) API.
+
+Quic exposes an API at `https://api.quic.nz/v1/` that gives customers access
+to their service configuration, live session data (connection status, assigned
+IP addresses, PPPoE/DHCP details), and a network weather map.  This library
+wraps that API with a clean, fully-typed async interface built on
+[aiohttp](https://docs.aiohttp.org/).
+
+> **Home Assistant integration:** A separate `ha-quicnz` custom integration
+> that uses this library as a dependency is maintained in a different repository.
+
+> **Disclaimer:** This project is an independent, community-maintained library
+> and is **not affiliated with, endorsed by, or supported by Quic Broadband /
+> Vetta Trading Ltd** in any way.  Use it at your own risk.
+
+---
+
+## Requirements
+
+- Python 3.11+
+- aiohttp ≥ 3.9
+
+## Installation
+
+```bash
+pip install quicnz
+```
+
+## Getting an API key
+
+Log in to the [Quic portal](https://account.quic.nz/), navigate to **Settings**,
+and generate an API key.
+
+## Quick start
+
+```python
+import asyncio
+from quicnz import QuicClient
+
+async def main():
+    # api_key can also be supplied via the QUICNZ_API_KEY environment variable
+    async with QuicClient(api_key="YOUR_API_KEY") as client:
+        # List all services associated with your account
+        service_ids = await client.get_services()
+        print("Services:", service_ids)
+
+        # Fetch the active session for the first service
+        session = await client.get_session(service_ids[0])
+        print("Connected:", session.is_connected)
+        print("IPv4:", session.active_ipv4_prefix)
+        print("IPv6:", session.active_ipv6_prefix)
+        print("LFC:", session.service.lfc)
+
+asyncio.run(main())
+```
+
+Or omit `api_key` and set the environment variable instead:
+
+```bash
+export QUICNZ_API_KEY="YOUR_API_KEY"
+```
+
+```python
+async with QuicClient() as client:
+    ...
+```
+
+## Reusing an aiohttp session
+
+If your application already manages an `aiohttp.ClientSession` you can pass it
+in to avoid creating an extra connection pool:
+
+```python
+import aiohttp
+from quicnz import QuicClient
+
+async with aiohttp.ClientSession() as http_session:
+    client = QuicClient(api_key="YOUR_API_KEY", session=http_session)
+    session = await client.get_session("service123")
+```
+
+## API reference
+
+### `QuicClient(api_key=None, *, session=None)`
+
+Main entry point.  Use as an async context manager or pass an existing
+`aiohttp.ClientSession`.  If `api_key` is omitted, the `QUICNZ_API_KEY`
+environment variable is used.  A `ValueError` is raised if neither is provided.
+
+| Method | Returns | Description |
+|---|---|---|
+| `get_services()` | `list[str]` | Service IDs authorised for this API key |
+| `get_session(service_id)` | `Session` | Active session for a service |
+| `get_weathermap()` | `bytes` | JPEG bytes of the Quic network weather map |
+
+### `Session`
+
+| Attribute | Type | Description |
+|---|---|---|
+| `status` | `str` | e.g. `"connected"` |
+| `is_connected` | `bool` | `True` when `status == "connected"` |
+| `session_type` | `str` | `"DHCP"` or `"PPPoE"` |
+| `active_ipv4_prefix` | `str` | Assigned IPv4 address |
+| `active_ipv4_prefix_length` | `int` | IPv4 prefix length |
+| `active_ipv6_prefix` | `str` | Assigned IPv6 prefix |
+| `active_ipv6_prefix_length` | `int` | IPv6 prefix length |
+| `last_radius_update` | `datetime` | Last RADIUS accounting update |
+| `session_expires_at` | `datetime` | When the session expires |
+| `ppp_payload` | `PPPPayload \| None` | PPPoE session details (PPPoE only) |
+| `service` | `ServiceInfo` | Static service configuration |
+| `created_at` | `datetime` | |
+| `updated_at` | `datetime` | |
+
+### `ServiceInfo`
+
+| Attribute | Type | Description |
+|---|---|---|
+| `username` | `str` | PPPoE/DHCP username |
+| `lfc` | `str` | Local Fibre Company (e.g. `"Chorus"`) |
+| `status` | `str` | Service status (e.g. `"active"`) |
+| `asid` | `str` | AS identifier |
+| `datacap` | `float` | Data cap (0 = uncapped) |
+| `static_ipv4_prefix` | `str` | Static IPv4 prefix (if any) |
+| `static_ipv6_prefix` | `str` | Static IPv6 prefix (if any) |
+| `routes` | `list[str]` | Announced routes |
+
+### Exceptions
+
+| Exception | When raised |
+|---|---|
+| `QuicAuthError` | HTTP 403 – invalid or missing API key |
+| `QuicNotFoundError` | HTTP 404 – resource not found |
+| `QuicAPIError` | Any other HTTP error; has `.status: int` attribute |
+| `QuicError` | Base class for all quicnz exceptions |
+
+## Rate limits
+
+The Quic API enforces a limit of **120 requests per minute**.  Session data is
+cached server-side for 5 minutes; the weather map is cached for 6 minutes.
+
+## Development
+
+```bash
+# Clone and install in editable mode with dev extras
+git clone https://github.com/quicnz/quicnz
+cd quicnz
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Lint / type-check
+ruff check src tests
+mypy src
+```
+
+## Licence
+
+[MIT](LICENSE)

quicnz-0.1.0/README.md

@@ -0,0 +1,161 @@
+# quicnz
+
+Async Python library for the [Quic broadband](https://quic.nz) API.
+
+Quic exposes an API at `https://api.quic.nz/v1/` that gives customers access
+to their service configuration, live session data (connection status, assigned
+IP addresses, PPPoE/DHCP details), and a network weather map.  This library
+wraps that API with a clean, fully-typed async interface built on
+[aiohttp](https://docs.aiohttp.org/).
+
+> **Home Assistant integration:** A separate `ha-quicnz` custom integration
+> that uses this library as a dependency is maintained in a different repository.
+
+> **Disclaimer:** This project is an independent, community-maintained library
+> and is **not affiliated with, endorsed by, or supported by Quic Broadband /
+> Vetta Trading Ltd** in any way.  Use it at your own risk.
+
+---
+
+## Requirements
+
+- Python 3.11+
+- aiohttp ≥ 3.9
+
+## Installation
+
+```bash
+pip install quicnz
+```
+
+## Getting an API key
+
+Log in to the [Quic portal](https://account.quic.nz/), navigate to **Settings**,
+and generate an API key.
+
+## Quick start
+
+```python
+import asyncio
+from quicnz import QuicClient
+
+async def main():
+    # api_key can also be supplied via the QUICNZ_API_KEY environment variable
+    async with QuicClient(api_key="YOUR_API_KEY") as client:
+        # List all services associated with your account
+        service_ids = await client.get_services()
+        print("Services:", service_ids)
+
+        # Fetch the active session for the first service
+        session = await client.get_session(service_ids[0])
+        print("Connected:", session.is_connected)
+        print("IPv4:", session.active_ipv4_prefix)
+        print("IPv6:", session.active_ipv6_prefix)
+        print("LFC:", session.service.lfc)
+
+asyncio.run(main())
+```
+
+Or omit `api_key` and set the environment variable instead:
+
+```bash
+export QUICNZ_API_KEY="YOUR_API_KEY"
+```
+
+```python
+async with QuicClient() as client:
+    ...
+```
+
+## Reusing an aiohttp session
+
+If your application already manages an `aiohttp.ClientSession` you can pass it
+in to avoid creating an extra connection pool:
+
+```python
+import aiohttp
+from quicnz import QuicClient
+
+async with aiohttp.ClientSession() as http_session:
+    client = QuicClient(api_key="YOUR_API_KEY", session=http_session)
+    session = await client.get_session("service123")
+```
+
+## API reference
+
+### `QuicClient(api_key=None, *, session=None)`
+
+Main entry point.  Use as an async context manager or pass an existing
+`aiohttp.ClientSession`.  If `api_key` is omitted, the `QUICNZ_API_KEY`
+environment variable is used.  A `ValueError` is raised if neither is provided.
+
+| Method | Returns | Description |
+|---|---|---|
+| `get_services()` | `list[str]` | Service IDs authorised for this API key |
+| `get_session(service_id)` | `Session` | Active session for a service |
+| `get_weathermap()` | `bytes` | JPEG bytes of the Quic network weather map |
+
+### `Session`
+
+| Attribute | Type | Description |
+|---|---|---|
+| `status` | `str` | e.g. `"connected"` |
+| `is_connected` | `bool` | `True` when `status == "connected"` |
+| `session_type` | `str` | `"DHCP"` or `"PPPoE"` |
+| `active_ipv4_prefix` | `str` | Assigned IPv4 address |
+| `active_ipv4_prefix_length` | `int` | IPv4 prefix length |
+| `active_ipv6_prefix` | `str` | Assigned IPv6 prefix |
+| `active_ipv6_prefix_length` | `int` | IPv6 prefix length |
+| `last_radius_update` | `datetime` | Last RADIUS accounting update |
+| `session_expires_at` | `datetime` | When the session expires |
+| `ppp_payload` | `PPPPayload \| None` | PPPoE session details (PPPoE only) |
+| `service` | `ServiceInfo` | Static service configuration |
+| `created_at` | `datetime` | |
+| `updated_at` | `datetime` | |
+
+### `ServiceInfo`
+
+| Attribute | Type | Description |
+|---|---|---|
+| `username` | `str` | PPPoE/DHCP username |
+| `lfc` | `str` | Local Fibre Company (e.g. `"Chorus"`) |
+| `status` | `str` | Service status (e.g. `"active"`) |
+| `asid` | `str` | AS identifier |
+| `datacap` | `float` | Data cap (0 = uncapped) |
+| `static_ipv4_prefix` | `str` | Static IPv4 prefix (if any) |
+| `static_ipv6_prefix` | `str` | Static IPv6 prefix (if any) |
+| `routes` | `list[str]` | Announced routes |
+
+### Exceptions
+
+| Exception | When raised |
+|---|---|
+| `QuicAuthError` | HTTP 403 – invalid or missing API key |
+| `QuicNotFoundError` | HTTP 404 – resource not found |
+| `QuicAPIError` | Any other HTTP error; has `.status: int` attribute |
+| `QuicError` | Base class for all quicnz exceptions |
+
+## Rate limits
+
+The Quic API enforces a limit of **120 requests per minute**.  Session data is
+cached server-side for 5 minutes; the weather map is cached for 6 minutes.
+
+## Development
+
+```bash
+# Clone and install in editable mode with dev extras
+git clone https://github.com/quicnz/quicnz
+cd quicnz
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Lint / type-check
+ruff check src tests
+mypy src
+```
+
+## Licence
+
+[MIT](LICENSE)

quicnz-0.1.0/examples/README.md

@@ -0,0 +1,39 @@
+# Examples
+
+These scripts demonstrate how to use the `quicnz` library.
+
+## API key setup
+
+The examples read your Quic API key from `~/.quicnz_api.key`.
+
+1. Log in to the [Quic portal](https://account.quic.nz/), select a service, navigate to the bottom of the page, below your product details, and you should find your API key. If the field is empty, click "Roll API Key" to generate the key.
+
+2. Save it to the key file:
+
+   ```bash
+   echo "YOUR_API_KEY" > ~/.quicnz_api.key
+   ```
+
+3. Make sure to restrict permissions so only your user can read it:
+
+   ```bash
+   chmod og-rwx ~/.quicnz_api.key
+   ```
+
+## Running the examples
+
+Install the library first:
+
+```bash
+pip install quicnz
+```
+
+Then run any example directly:
+
+```bash
+python examples/list_services.py
+python examples/session_status.py                 # uses your first service
+python examples/session_status.py service123      # specify a service ID
+python examples/download_weathermap.py            # saves weathermap.jpg
+python examples/download_weathermap.py ~/map.jpg  # custom output path
+```

quicnz-0.1.0/examples/_auth.py

@@ -0,0 +1,48 @@
+"""Shared helper: load the Quic API key for example scripts.
+
+The key is read from ~/.quicnz_api.key (plain text, one line).
+If that file does not exist, the QUICNZ_API_KEY environment variable is used
+as a fallback.
+
+See examples/README.md for setup instructions.
+"""
+
+from __future__ import annotations
+
+import os
+import stat
+import sys
+from pathlib import Path
+
+_KEY_FILE = Path("~/.quicnz_api.key").expanduser()
+
+
+def load_api_key() -> str:
+    """Return the API key, or exit with a helpful message if it cannot be found."""
+    if _KEY_FILE.exists():
+        _warn_if_permissive(_KEY_FILE)
+        key = _KEY_FILE.read_text().strip()
+        if key:
+            return key
+
+    env_key = os.environ.get("QUICNZ_API_KEY", "").strip()
+    if env_key:
+        return env_key
+
+    sys.exit(
+        f"No API key found.\n"
+        f"  Create {_KEY_FILE} containing your Quic API key, then run:\n"
+        f"    chmod og-rwx {_KEY_FILE}\n"
+        f"  Or set the QUICNZ_API_KEY environment variable."
+    )
+
+
+def _warn_if_permissive(path: Path) -> None:
+    """Warn when the key file is readable by group or others."""
+    mode = path.stat().st_mode
+    if mode & (stat.S_IRGRP | stat.S_IWGRP | stat.S_IROTH | stat.S_IWOTH):
+        print(
+            f"Warning: {path} is readable by others. "
+            f"Run: chmod og-rwx {path}",
+            file=sys.stderr,
+        )

quicnz-0.1.0/examples/download_weathermap.py

@@ -0,0 +1,29 @@
+"""Download the Quic network weather map and save it as a JPEG file.
+
+Usage:
+    python download_weathermap.py              # saves to weathermap.jpg
+    python download_weathermap.py ~/map.jpg    # custom output path
+"""
+
+import asyncio
+import sys
+from pathlib import Path
+
+from quicnz import QuicClient
+
+from _auth import load_api_key
+
+DEFAULT_OUTPUT = Path("weathermap.jpg")
+
+
+async def main(output: Path) -> None:
+    async with QuicClient(api_key=load_api_key()) as client:
+        data = await client.get_weathermap()
+
+    output.write_bytes(data)
+    print(f"Weather map saved to {output} ({len(data):,} bytes)")
+
+
+if __name__ == "__main__":
+    out = Path(sys.argv[1]).expanduser() if len(sys.argv) > 1 else DEFAULT_OUTPUT
+    asyncio.run(main(out))

quicnz-0.1.0/examples/list_services.py

@@ -0,0 +1,24 @@
+"""List all service IDs associated with your Quic account."""
+
+import asyncio
+
+from quicnz import QuicClient
+
+from _auth import load_api_key
+
+
+async def main() -> None:
+    async with QuicClient(api_key=load_api_key()) as client:
+        service_ids = await client.get_services()
+
+    if not service_ids:
+        print("No services found for this API key.")
+        return
+
+    print(f"Found {len(service_ids)} service(s):")
+    for sid in service_ids:
+        print(f"  {sid}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

quicnz-0.1.0/examples/session_status.py

@@ -0,0 +1,71 @@
+"""Show the active session status for a Quic service.
+
+Usage:
+    python session_status.py              # uses the first service on your account
+    python session_status.py <service-id> # specify a service ID explicitly
+"""
+
+import asyncio
+import sys
+from datetime import timezone
+
+from quicnz import QuicClient, QuicNotFoundError
+
+from _auth import load_api_key
+
+
+async def main(service_id: str | None) -> None:
+    async with QuicClient(api_key=load_api_key()) as client:
+        if service_id is None:
+            service_ids = await client.get_services()
+            if not service_ids:
+                sys.exit("No services found for this API key.")
+            service_id = service_ids[0]
+            if len(service_ids) > 1:
+                print(f"Multiple services found; showing first: {service_id}")
+
+        try:
+            session = await client.get_session(service_id)
+        except QuicNotFoundError:
+            sys.exit(f"No active session found for service '{service_id}'.")
+
+    # ---- service configuration ----
+    svc = session.service
+    print(f"Service ID   : {service_id}")
+    print(f"LFC          : {svc.lfc}")
+    print(f"Entity       : {svc.entity} (ID: {svc.entity_unique_id})")
+    print(f"Service status: {svc.status}")
+    print(f"Username     : {svc.username}")
+    if svc.datacap:
+        print(f"Data cap     : {svc.datacap} GB")
+    else:
+        print(f"Data cap     : uncapped")
+
+    # ---- session ----
+    print()
+    connected = "YES" if session.is_connected else "NO"
+    print(f"Connected    : {connected}  ({session.status})")
+    print(f"Session type : {session.session_type}")
+    print(f"IPv4 address : {session.active_ipv4_prefix}/{session.active_ipv4_prefix_length}")
+    print(f"IPv6 prefix  : {session.active_ipv6_prefix}/{session.active_ipv6_prefix_length}")
+
+    local_expires = session.session_expires_at.astimezone()
+    print(f"Session expires : {local_expires.strftime('%Y-%m-%d %H:%M:%S %Z')}")
+
+    local_updated = session.last_radius_update.astimezone()
+    print(f"Last RADIUS update: {local_updated.strftime('%Y-%m-%d %H:%M:%S %Z')}")
+
+    # ---- PPPoE details (if present) ----
+    if session.ppp_payload:
+        ppp = session.ppp_payload
+        print()
+        print("PPPoE details:")
+        print(f"  NAS identifier  : {ppp.nas_identifier}")
+        print(f"  Circuit ID      : {ppp.adsl_agent_circuit_id}")
+        print(f"  Remote ID       : {ppp.adsl_agent_remote_id}")
+        print(f"  Calling station : {ppp.calling_station_id}")
+
+
+if __name__ == "__main__":
+    arg = sys.argv[1] if len(sys.argv) > 1 else None
+    asyncio.run(main(arg))

quicnz-0.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "quicnz"
+version = "0.1.0"
+description = "Async Python library for the Quic broadband API (unofficial, not affiliated with Quic Broadband / Vetta Trading Ltd)"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [
+    { name = "Aurélien Geron" },
+]
+keywords = ["quic", "broadband", "nz", "api"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [
+    "aiohttp>=3.9",
+]
+
+[project.urls]
+Homepage = "https://github.com/quicnz/quicnz"
+Repository = "https://github.com/quicnz/quicnz"
+Issues = "https://github.com/quicnz/quicnz/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.23",
+    "aioresponses>=0.7",
+    "ruff>=0.4",
+    "mypy>=1.10",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/quicnz"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+files = ["src"]