Skip to main content

Qualytics CLI

Command-line interface for the Qualytics data quality platform.

PyPI Python Tests License: MIT

Manage connections, datastores, containers, quality checks, anomalies, and operations as code. Export your entire Qualytics configuration to git-tracked YAML files and deploy across environments through CI/CD pipelines.

Installation

pip install qualytics-cli

Or with uv (faster):

uv pip install qualytics-cli

Requirements: Python 3.10 or higher.

Quick Start

# 1. Authenticate via browser (recommended)
uv run qualytics auth login --url "https://your-instance.qualytics.io/"

# 2. Check connectivity and API compatibility
qualytics doctor

# 3. Export your datastore configuration to YAML
qualytics config export --datastore-id 1 --output ./qualytics-config

# 4. Preview what an import would do (without making changes)
qualytics config import --input ./qualytics-config --dry-run

Commands

Group Description
auth Authenticate and manage credentials
connections Create and manage database connections
datastores Create and manage datastores
containers Create and manage computed containers
checks Create and manage quality checks
anomalies View and manage detected anomalies
operations Trigger sync, profile, and scan operations
config Export and import configuration as code
users List and view users
teams List and view teams
tags Manage tags (list, create, delete)
schedule Schedule recurring operations
mcp Start the MCP server for LLM integration
doctor Check CLI health, connectivity, and API compatibility

Run qualytics <command> --help for full details on any command.

Documentation

Guide Description
Getting Started Authentication, configuration, environment variables
Connections Creating and managing database connections
Datastores Creating and managing datastores
Quality Checks Creating checks from YAML (single and bulk)
Operations Sync, profile, scan workflows
Export/Import Config-as-code: export, import, CI/CD promotion
Anomalies Viewing and managing anomalies
Computed Fields User-defined computed fields in export/import
Computed Tables Bulk import of computed tables from Excel/CSV
MCP Server LLM integration with Claude Code, Cursor, etc.
CI/CD Promotion GitHub Actions workflow for environment promotion

Development

git clone https://github.com/Qualytics/qualytics-cli.git
cd qualytics-cli
uv sync                              # Install dependencies
uv run pytest                        # Run tests
uv run pre-commit run --all-files    # Lint, format, type checks

For architecture details and contribution guidelines, see AGENTS.md.

Releasing

Releases are automated via GitHub Actions. The version lives in pyproject.toml and is managed by uv version.

Steps to release a new version

  1. Ensure main is green -- CI (lint + tests across Python 3.10-3.14 + pre-commit) must pass.

  2. Trigger the Release workflow -- Go to Actions > Release and click Run workflow. Select the bump type:

    • patch -- bug fixes (1.0.0 → 1.0.1)
    • minor -- new features (1.0.0 → 1.1.0)
    • major -- breaking changes (1.0.0 → 2.0.0)
  3. The workflow automatically:

    • Bumps the version in pyproject.toml via uv version --bump <type>
    • Commits the change and creates a v{version} git tag
    • Pushes the commit and tag to main
  4. The tag push triggers the Publish workflow, which:

    • Builds the package (uv build)
    • Publishes to PyPI via OIDC trusted publishing (no API tokens needed)
    • Creates a GitHub Release with auto-generated release notes and attached artifacts

Manual version check

# Current version in pyproject.toml
uv version --short

# Installed version
qualytics --version

License

MIT License -- see LICENSE for 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-1.1.0.tar.gz (325.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qualytics_cli-1.1.0-py3-none-any.whl (125.5 kB view details)

Uploaded Python 3

File details

Details for the file qualytics_cli-1.1.0.tar.gz.

File metadata

  • Download URL: qualytics_cli-1.1.0.tar.gz
  • Upload date:
  • Size: 325.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for qualytics_cli-1.1.0.tar.gz
Algorithm Hash digest
SHA256 6cd56dca04c72e75bc6554369ed6ec1897b26e10c65c3a975e5e1efc25ceb538
MD5 6fcbe280e09f16dd9703e12788d27274
BLAKE2b-256 15723814ba9c18d53deff628abb7a81a921406dc88f39ed42016b1bd619442b1

See more details on using hashes here.

File details

Details for the file qualytics_cli-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: qualytics_cli-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 125.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for qualytics_cli-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f3db5262cdf2d99354d46dc91044bdddf19a3df0e205cee990ff154782ec3307
MD5 ad0fd6028348ee8fccef6c2dab94fcf5
BLAKE2b-256 b837decf0d93fafce499c19c299b7428abfe0b58e0260c945bbf1a42ea450680

See more details on using hashes here.

Release history Release notifications | RSS feed

1.2.0

2 files

This release

1.1.0 This release

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.19

2 files

0.1.18

2 files

0.1.17

2 files

0.1.16

2 files

0.1.15

2 files

0.1.14

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page