Skip to main content

A CLI tool for managing the data catalog platform.

Project description

Installation 📦

Install LumaCLI via pip:

pip install lumaCLI

lumaCLI

Usage:

$ lumaCLI [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • dbt
  • postgres

lumaCLI dbt

Usage:

$ lumaCLI dbt [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • ingest: Sends a bundle of JSON files...
  • send-test-results: Sends the run_results.json file located in...

lumaCLI dbt ingest

Sends a bundle of JSON files (manifest.json, catalog.json, sources.json, run_results.json) located in the specified directory to a Luma endpoint. If any of these files is not present in the directory, the command will fail. Uses the current working directory if 'metadata_dir' is not specified.

Usage:

$ lumaCLI dbt ingest [OPTIONS] [METADATA_DIR]

Arguments:

  • [METADATA_DIR]: Path to the directory with dbt metadata files. If not provided, current working directory will be used.

Options:

  • -e, --endpoint TEXT: URL of the ingestion endpoint. [env var: LUMA_DBT_INGEST_ENDPOINT; required]
  • --help: Show this message and exit.

lumaCLI dbt send-test-results

Sends the run_results.json file located in the specified directory to a Luma endpoint. The command will fail if the run_results.json file is not present in the directory. Uses the current working directory if 'metadata_dir' is not specified.

Usage:

$ lumaCLI dbt send-test-results [OPTIONS] [METADATA_DIR]

Arguments:

  • [METADATA_DIR]: Path to the directory with the run_results.json file. If not provided, current working directory will be used.

Options:

  • -e, --endpoint TEXT: URL of the ingestion endpoint. [env var: LUMA_DBT_SEND-TEST-RESULTS_ENDPOINT; required]
  • --help: Show this message and exit.

lumaCLI postgres

Usage:

$ lumaCLI postgres [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • ingest: Creates dictionary with Postgres Metadata...

lumaCLI postgres ingest

Creates dictionary with Postgres Metadata Information and sends it to the Luma Postgres ingest endpoint.

Usage:

$ lumaCLI postgres ingest [OPTIONS] ENDPOINT

Arguments:

  • ENDPOINT: URL of the Luma Postgres ingestion endpoint. [env var: LUMA_POSTGRES_INGEST_ENDPOINT;required]

Options:

  • -u, --username TEXT: PostgreSQL username. [env var: LUMA_POSTGRES_USERNAME; required]
  • -d, --database TEXT: PostgreSQL database. [env var: LUMA_POSTGRES_DATABASE; required]
  • -h, --host TEXT: PostgreSQL host. [env var: LUMA_POSTGRES_HOST; default: localhost]
  • -p, --port TEXT: PostgreSQL port. [env var: LUMA_POSTGRES_PORT; default: 5432]
  • -P, --password TEXT: PostgreSQL password. [env var: LUMA_POSTGRES_PASSWORD; required]
  • -D, --dry-run: Whether to do a dry run. Print but not send the payload
  • --help: Show this message and exit.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lumacli-0.0.5.tar.gz (26.0 kB view hashes)

Uploaded Source

Built Distribution

lumacli-0.0.5-py3-none-any.whl (30.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page