Metadata-Version: 2.4
Name: katalogue-sdk
Version: 0.7.0
Summary: Python SDK Katalogue
Project-URL: Homepage, https://katalogue.se
Project-URL: Documentation, https://kayentaconsulting.github.io/katalogue-python/
Project-URL: Repository, https://github.com/kayentaconsulting/katalogue-python
Project-URL: Bug Tracker, https://github.com/kayentaconsulting/katalogue-python/issues
Author-email: Kayenta Consulting AB <hello@katalogue.se>
License: MIT
Keywords: data catalog,katalogue,sdk
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
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 :: Database
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Requires-Dist: jinja2<4,>=3
Requires-Dist: pydantic>=2.0
Requires-Dist: pyyaml>=6
Requires-Dist: requests-oauthlib>=1.3
Requires-Dist: requests>=2.31
Description-Content-Type: text/markdown

# katalogue-sdk

Python client for [Katalogue](https://katalogue.se), built on the Katalogue REST API.
Standalone — no CLI or Click dependency — for use in scripts, notebooks, services,
and agents.

## Installation

```bash
pip install katalogue-sdk
# or with uv
uv add katalogue-sdk
```

## Quick start

```python
from katalogue import KatalogueClient, GetOptions

client = KatalogueClient()  # reads KATALOGUE_CLIENT_ID / _SECRET / _URL from the environment

# List all systems
result = client.get("system")
print(result.data)  # list of dicts

# All PII fields, selected columns, sorted
result = client.get("field", GetOptions(
    filters=["is_pii=true"],
    properties=["field_id", "field_name", "dataset_name"],
    sort=[{"field_name": "asc"}],
))
print(result.data)
```

Get API credentials by [creating an OAuth2 client in Katalogue](https://docs.katalogue.se/using-katalogue/katalogue_cli_and_sdk/#granting-access-to-katalogue).

## Documentation

Full documentation is published at
[kayentaconsulting.github.io/katalogue-python](https://kayentaconsulting.github.io/katalogue-python/):

- [Getting started](https://kayentaconsulting.github.io/katalogue-python/getting-started/)
- [Client and authentication](https://kayentaconsulting.github.io/katalogue-python/sdk/client/)
- [Options and results](https://kayentaconsulting.github.io/katalogue-python/sdk/options/)
- [Filtering and selection](https://kayentaconsulting.github.io/katalogue-python/reference/filtering/)
- [Templates](https://kayentaconsulting.github.io/katalogue-python/guides/templates/)
 · [Exporting](https://kayentaconsulting.github.io/katalogue-python/guides/exporting/)
 · [Datatype conversion](https://kayentaconsulting.github.io/katalogue-python/guides/datatype-conversion/)
