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 is published at kayentaconsulting.github.io/katalogue-python:

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

katalogue_sdk-0.7.0.tar.gz (62.9 kB view details)

Uploaded Jul 1, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

katalogue_sdk-0.7.0-py3-none-any.whl (43.2 kB view details)

Uploaded Jul 1, 2026 Python 3

File details

Details for the file katalogue_sdk-0.7.0.tar.gz.

File metadata

Download URL: katalogue_sdk-0.7.0.tar.gz
Upload date: Jul 1, 2026
Size: 62.9 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for katalogue_sdk-0.7.0.tar.gz
Algorithm	Hash digest
SHA256	`b81a57c3daf2b63cb65cebd348a20a3aec87956e1d24cd17cbf69099c7989d59`
MD5	`4745eeaf8f893ba3180f5fe0f7eee031`
BLAKE2b-256	`7ac125ec47762ee6d54ce6761f70e70a3b69faac81cf9f4f215380b8bf39833b`

See more details on using hashes here.

File details

Details for the file katalogue_sdk-0.7.0-py3-none-any.whl.

File metadata

Download URL: katalogue_sdk-0.7.0-py3-none-any.whl
Upload date: Jul 1, 2026
Size: 43.2 kB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for katalogue_sdk-0.7.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`b564356e10ea43674843170ac936605a34afe4d04522b93f36089215072d7d4a`
MD5	`569b49d05d8f3ea22fb49574c811b1a0`
BLAKE2b-256	`0ce2b97047a8aed4d342d64535fe597174aa15883e17c2fd5ba49a53b40c6713`