Metadata-Version: 2.1
Name: odd-cli
Version: 0.1.18
Summary: Command line tool for working with OpenDataDiscovery. 
Keywords: Open Data Discovery,Metadata,Data Discovery,Data Observability
Author: Pavel Makarichev
Author-email: vixtir90@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: loguru (>=0.6.0,<0.7.0)
Requires-Dist: odd-dbt (>=0.1.11,<0.2.0)
Requires-Dist: odd-models (>=2.0.24,<3.0.0)
Requires-Dist: oddrn-generator (>=0.1.70,<0.2.0)
Requires-Dist: pyarrow (>=10.0.1,<11.0.0)
Requires-Dist: tqdm (>=4.64.1,<5.0.0)
Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
Description-Content-Type: text/markdown

## OpenDataDiscovery CLI
[![PyPI version](https://badge.fury.io/py/odd-cli.svg)](https://badge.fury.io/py/odd-cli)

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
```bash
pip install odd-cli
```

#### Available commands
```text
╭─ 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](https://docs.opendatadiscovery.org/configuration-and-deployment/trylocally#create-collector-entity) or `odd tokens create` command.

## Commands
Create collector token.
```bash
odd tokens create <collector_name>
```

Parse and ingest local files
```bash
odd collect <path_to_folder_with_datasets>
```

Run dbt tests and inject results to ODD platform. It uses [odd-dbt](https://github.com/opendatadiscovery/odd-dbt) package.
```bash
odd dbt <path_to_dbt_project>
```

