Metadata-Version: 2.4
Name: zinn-sdk
Version: 0.1.1308
Summary: A client library for accessing Zinn Digital® Platform API
Keywords: zinn,hosting,api,sdk
Author: Zinn Digital Ltd
Author-email: Zinn Digital Ltd <office@zinndigital.com>
License-Expression: MIT
License-File: LICENSE
Requires-Dist: httpx>=0.23.1,<0.29.0
Requires-Dist: attrs>=22.2.0
Requires-Python: >=3.11
Project-URL: Homepage, https://zinndigital.com/developers
Project-URL: Documentation, https://zinndigital.com/developers/api
Description-Content-Type: text/markdown

# zinn-sdk — Python client for the Zinn Digital Platform API

Typed Python client for the [Zinn Digital](https://zinndigital.com/developers) public API, generated from
the platform's OpenAPI specification — the same file the API, the dashboard and the docs are built from.
A new version is published automatically whenever the specification changes.

```bash
pip install zinn-sdk
```

```python
from zinn_sdk import Client, AuthenticatedClient
from zinn_sdk.api.catalog import list_public_hosting_regions
from zinn_sdk.api.sites import list_sites

# Public catalogue endpoints need no key.
regions = list_public_hosting_regions.sync(client=Client(base_url="https://api.zinndigital.com"))
print([r.slug for r in regions.data])

# Everything else uses a per-organisation API key (create one on the dashboard's API keys page).
api = AuthenticatedClient(base_url="https://api.zinndigital.com", token="YOUR_API_KEY")
sites = list_sites.sync(client=api)
```

Every operation has `sync`, `sync_detailed`, `asyncio` and `asyncio_detailed` variants, named after the
operation's `operationId` in snake case, grouped by tag under `zinn_sdk.api`.

- API reference: https://zinndigital.com/developers/api
- Licence: MIT
