Metadata-Version: 2.4
Name: katalogue-cli
Version: 0.6.2
Summary: CLI for 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: cli,data catalog,katalogue
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
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 :: Utilities
Requires-Python: >=3.11
Requires-Dist: click>=8.1
Requires-Dist: katalogue-sdk>=0.0.0a0
Requires-Dist: keyring>=24.0
Requires-Dist: platformdirs>=4.0
Description-Content-Type: text/markdown

# katalogue-cli

Command-line interface for [Katalogue](https://katalogue.se), built on the Katalogue
REST API. A thin wrapper over [`katalogue-sdk`](https://pypi.org/project/katalogue-sdk/).

## Installation

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

## Quick start

```bash
# Store credentials once (client secret goes to your OS keychain)
katalogue auth login

# ...or use environment variables
export KATALOGUE_CLIENT_ID=...
export KATALOGUE_CLIENT_SECRET=...
export KATALOGUE_URL=https://your-instance.katalogue.se

# First call
katalogue system list
```

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 lives in the repository:

- [Getting started](https://github.com/kayentaconsulting/katalogue-python/blob/main/docs/getting-started.md)
- [Command reference](https://github.com/kayentaconsulting/katalogue-python/blob/main/docs/cli/commands.md)
- [Output formats and file output](https://github.com/kayentaconsulting/katalogue-python/blob/main/docs/cli/output-formats.md)
- [Filtering and selection](https://github.com/kayentaconsulting/katalogue-python/blob/main/docs/reference/filtering.md)
- [Templates](https://github.com/kayentaconsulting/katalogue-python/blob/main/docs/guides/templates.md)
 · [Exporting](https://github.com/kayentaconsulting/katalogue-python/blob/main/docs/guides/exporting.md)
 · [Datatype conversion](https://github.com/kayentaconsulting/katalogue-python/blob/main/docs/guides/datatype-conversion.md)
- [Troubleshooting](https://github.com/kayentaconsulting/katalogue-python/blob/main/docs/reference/troubleshooting.md)
- [Documentation index](https://github.com/kayentaconsulting/katalogue-python/blob/main/docs/index.md)
