Skip to content
Katalogue Docs

Katalogue CLI & SDK

The Katalogue project includes two open-source Python components for interacting with Katalogue programmatically: the SDK and the CLI. They are maintained in the same GitHub repository and designed to work together, but serve different audiences and use cases.

Quick Start

Section titled “Quick Start”

Install SDK only:

Terminal window
pip install katalogue-sdk

Install CLI and SDK:

Terminal window
pip install katalogue-cli

You must grant access to Katalogue to connect with the SDK/CLI to your Katalogue instance.

For detailed installation instructions, usage examples and full reference documentation, see:

https://github.com/kayentaconsulting/katalogue-python

Katalogue SDK

Section titled “Katalogue SDK”

The Katalogue SDK for Python is a Python library that wraps the Katalogue REST API. It is the foundation for any programmatic interaction with Katalogue and is the primary tool for Python developers building scripts, pipelines, and integrations.

Capabilities

Section titled “Capabilities”
  • API abstraction: Interact with Katalogue without writing direct HTTP calls
  • Metadata access: Retrieve measure definitions, business context, data asset relationships, and lineage
  • Automation-friendly: Designed for use in scripts, CI/CD pipelines, and data workflows

Use Cases

Section titled “Use Cases”
  • Automating metadata extraction for reporting or governance workflows
  • Integrating Katalogue with external Python tools and platforms
  • Building custom tooling on top of the Katalogue REST API, like dbt integrations.

Katalogue CLI

Section titled “Katalogue CLI”

The Katalogue CLI is a thin terminal wrapper built on top of the SDK. It exposes the same capabilities through a command-line interface, making it accessible without writing Python code. The CLI is particularly well-suited for AI agents that can invoke shell commands — they can query Katalogue metadata without needing to run Python directly.

Capabilities

Section titled “Capabilities”
  • All SDK capabilities, accessible from the command line
  • Terminal-friendly input/output for interactive metadata exploration
  • Easily invokable by AI agents as a shell tool

Use Cases

Section titled “Use Cases”
  • Enabling AI agents to query business metrics, descriptions, and data relationships
  • Quick metadata lookups directly from a terminal
  • Batch operations for Katalogue power users and admins
  • Supporting developer workflows without writing Python scripts

Grant Access To Katalogue

Section titled “Grant Access To Katalogue”

To use the SDK (and the CLI, as it builds upon the SDK), the Katalogue REST API must be enabled in your Katalogue instance.

Authentication is handled via OAuth2, which requires configuring an OpenID Connect (OIDC) client in Katalogue with the appropriate scopes. Follow the guide here to set up access: Using the Katalogue REST API

Once configured, the SDK and CLI can authenticate securely and perform API requests on behalf of the configured client.