## OpenDataDiscovery CLI
[](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 test <path_to_dbt_project>
```
Raw data
{
"_id": null,
"home_page": null,
"name": "odd-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "Open Data Discovery, Metadata, Data Discovery, Data Observability",
"author": "Pavel Makarichev",
"author_email": "vixtir90@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b4/c6/c0ae2efef7e9e3321a52b70c0c3414b5ace40a38f2be24e0079ed5950f3c/odd_cli-0.2.12.tar.gz",
"platform": null,
"description": "## OpenDataDiscovery CLI\n[](https://badge.fury.io/py/odd-cli)\n\nCommand line tool for working with OpenDataDiscovery.\nIt makes it easy to create token though console and ingest local dataset's metadata to OpenDataDiscovery platform.\n\n## Installation\n```bash\npip install odd-cli\n```\n\n#### Available commands\n```text\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --install-completion Install completion for the current shell. \u2502\n\u2502 --show-completion Show completion for the current shell, to copy it or customize the installation \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 collect Collect and ingest metadata for local files from folder \u2502\n\u2502 dbt Run dbt tests and inject results to ODD platform \u2502\n\u2502 tokens Manipulate OpenDataDiscovery platform's tokens \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n## Env variables used for commands\n\n`ODD_PLATFORM_HOST` - Location of OpenDataDiscovery Platform.\n\n`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.\n\n## Commands\nCreate collector token.\n```bash\nodd tokens create <collector_name>\n```\n\nParse and ingest local files\n```bash\nodd collect <path_to_folder_with_datasets>\n```\n\nRun dbt tests and inject results to ODD platform. It uses [odd-dbt](https://github.com/opendatadiscovery/odd-dbt) package.\n```bash\nodd dbt test <path_to_dbt_project>\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Command line tool for working with OpenDataDiscovery. ",
"version": "0.2.12",
"project_urls": null,
"split_keywords": [
"open data discovery",
" metadata",
" data discovery",
" data observability"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "532f2bf4695ee687653a0a78062ff60fa7e1621301f088085e3cfc1040e9f9e7",
"md5": "195818fa35e9622c14ca030438ee631c",
"sha256": "ec4ef3c5b53875926b811ba1af53c6bfb695055cf703a6859360ab91dcd09d59"
},
"downloads": -1,
"filename": "odd_cli-0.2.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "195818fa35e9622c14ca030438ee631c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 14042,
"upload_time": "2024-06-21T12:22:05",
"upload_time_iso_8601": "2024-06-21T12:22:05.889499Z",
"url": "https://files.pythonhosted.org/packages/53/2f/2bf4695ee687653a0a78062ff60fa7e1621301f088085e3cfc1040e9f9e7/odd_cli-0.2.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b4c6c0ae2efef7e9e3321a52b70c0c3414b5ace40a38f2be24e0079ed5950f3c",
"md5": "2ae861681f0da0ed60d9f98dd5764a7f",
"sha256": "7813255c20da899722aebe1726f2ed30452fad3b1af52546f381bd5591bc36ec"
},
"downloads": -1,
"filename": "odd_cli-0.2.12.tar.gz",
"has_sig": false,
"md5_digest": "2ae861681f0da0ed60d9f98dd5764a7f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 12500,
"upload_time": "2024-06-21T12:22:08",
"upload_time_iso_8601": "2024-06-21T12:22:08.014810Z",
"url": "https://files.pythonhosted.org/packages/b4/c6/c0ae2efef7e9e3321a52b70c0c3414b5ace40a38f2be24e0079ed5950f3c/odd_cli-0.2.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-21 12:22:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "odd-cli"
}
JSON