Skip to main content

Qualytics CLI

Project description

Qualytics CLI

This is a CLI tool for working with Qualytics API. With this tool, you can manage your configurations, export checks, import checks, and more. It's built on top of the Typer CLI framework and uses the rich library for fancy terminal prints.

Requirements

  • Python 3.7+
  • Packages:
    • typer
    • os
    • json
    • requests
    • urllib3
    • re
    • rich

Installation

    pip install qualytics-cli

Usage

Help

qualytics --help

Initializing the Configuration

You can set up your Qualytics URL and token using the init command:

qualytics init --url "https://your-qualytics.qualytics.io/" --token "YOUR_TOKEN_HERE"
Option Type Description Default Required
--url TEXT The URL to be set. Example: https://your-qualytics.qualytics.io/ None Yes
--token TEXT The token to be set. None Yes

Qualytics init help

qualytics init --help

Display Configuration

To view the currently saved configuration:

qualytics show-config

Export Checks

You can export checks to a file using the checks export command:

qualytics checks export --datastore DATASTORE_ID

By default, it saves the exported checks to ./qualytics/data_checks.json. However, you can specify a different output path with the --output option.

Option Type Description Default Required
--datastore INTEGER Datastore ID None Yes
--output TEXT Output file path ./qualytics/data_checks.json No

Import Checks

To import checks from a file:

qualytics checks import --datastore DATASTORE_ID_LIST

By default, it reads the checks from ./qualytics/data_checks.json. You can specify a different input file with the --input option.

Note: Any errors encountered during the importing of checks will be logged in ./qualytics/errors.log.

Option Type Description Default Required
--datastore TEXT Comma-separated list of Datastore IDs or array-like format. Example: 1,2,3,4,5 or "[1,2,3,4,5]" None Yes
--input TEXT Input file path

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

qualytics-cli-0.1.5.tar.gz (9.8 kB view hashes)

Uploaded Source

Built Distribution

qualytics_cli-0.1.5-py3-none-any.whl (9.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