opendatadiscovery / odd-cli

CLI for OpenDataDiscovery

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

OpenDataDiscovery CLI

PyPI version

Command line tool for working with OpenDataDiscovery. It makes it easy to create token though console and ingest local dataset's metadata to OpenDataDiscovery platform.

Installation

pip install odd-cli

Available commands

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.                                              │
│ --show-completion             Show completion for the current shell, to copy it or customize the installation        │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────╮
│ collect                       Collect and ingest metadata for local files from folder      │
│ dbt                           Run dbt tests and inject results to ODD platform             │
│ tokens                        Manipulate OpenDataDiscovery platform's tokens               │
╰────────────────────────────────────────────────────────────────────────────────────────────╯

Env variables used for commands

ODD_PLATFORM_HOST - Location of OpenDataDiscovery Platform.

ODD_PLATFORM_TOKEN - Collector token, can be created using UI or odd tokens create command.

Commands

Create collector token.

odd tokens create <collector_name>

Parse and ingest local files

odd collect <path_to_folder_with_datasets>

Run dbt tests and inject results to ODD platform. It uses odd-dbt package.

odd dbt test <path_to_dbt_project>

About

CLI for OpenDataDiscovery

License:Apache License 2.0


Languages

Language:Python 93.5%Language:Dockerfile 6.5%