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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for qualytics_cli-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fbd8751fbdc0e2df218e18a2461b99887571c23804988636ec92261904e65c2 |
|
MD5 | 00bb3a1e32e65f1d2f59d92aefc68429 |
|
BLAKE2b-256 | e372a55bcaf6221cbae083683048fda87dd9093acf5ad19c0ad35107f8e7fe16 |