katalogue-sdk 0.6.2

Python SDK Katalogue

katalogue-sdk

Python client for Katalogue, built on the Katalogue REST API. Standalone — no CLI or Click dependency — for use in scripts, notebooks, services, and agents.

Installation

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

Quick start

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.

Documentation

Full documentation lives in the repository:

• Getting started
• Client and authentication
• Options and results
• Filtering and selection
• Templates · Exporting · Datatype conversion
• Documentation index