odd-cli


Nameodd-cli JSON
Version 0.2.10 PyPI version JSON
download
home_page
SummaryCommand line tool for working with OpenDataDiscovery.
upload_time2023-11-03 15:26:01
maintainer
docs_urlNone
authorPavel Makarichev
requires_python>=3.9,<4.0
license
keywords open data discovery metadata data discovery data observability
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            ## 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 test <path_to_dbt_project>
```

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "odd-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "keywords": "Open Data Discovery,Metadata,Data Discovery,Data Observability",
    "author": "Pavel Makarichev",
    "author_email": "vixtir90@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d0/13/1cfa1585a5ea867ceb0a41bdb26bc3426c14e24e10a6563673e70190776d/odd_cli-0.2.10.tar.gz",
    "platform": null,
    "description": "## OpenDataDiscovery CLI\n[![PyPI version](https://badge.fury.io/py/odd-cli.svg)](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": "",
    "summary": "Command line tool for working with OpenDataDiscovery. ",
    "version": "0.2.10",
    "project_urls": null,
    "split_keywords": [
        "open data discovery",
        "metadata",
        "data discovery",
        "data observability"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2495cc3de72a4a408b674b6066ca6d59df9df310fe56d94bfb0f2f5f155b4b06",
                "md5": "840e72ce7014acad1aa4e7e4368eb8b3",
                "sha256": "56d164ab2fb980c53573aaf81260eda9999f31a671fdf1b6cbc75a76127c3d3a"
            },
            "downloads": -1,
            "filename": "odd_cli-0.2.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "840e72ce7014acad1aa4e7e4368eb8b3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 12831,
            "upload_time": "2023-11-03T15:25:58",
            "upload_time_iso_8601": "2023-11-03T15:25:58.661073Z",
            "url": "https://files.pythonhosted.org/packages/24/95/cc3de72a4a408b674b6066ca6d59df9df310fe56d94bfb0f2f5f155b4b06/odd_cli-0.2.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d0131cfa1585a5ea867ceb0a41bdb26bc3426c14e24e10a6563673e70190776d",
                "md5": "0faa494d9218d730d851ee8ecb3e10cd",
                "sha256": "15040576864eefa89f1d18065f75b4c80ef8351447c3e1158c62d221f2209838"
            },
            "downloads": -1,
            "filename": "odd_cli-0.2.10.tar.gz",
            "has_sig": false,
            "md5_digest": "0faa494d9218d730d851ee8ecb3e10cd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 9933,
            "upload_time": "2023-11-03T15:26:01",
            "upload_time_iso_8601": "2023-11-03T15:26:01.195319Z",
            "url": "https://files.pythonhosted.org/packages/d0/13/1cfa1585a5ea867ceb0a41bdb26bc3426c14e24e10a6563673e70190776d/odd_cli-0.2.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-03 15:26:01",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "odd-cli"
}
Pavel Makarichev
Elapsed time: 0.13714s