Skip to main content

Standalone CLI for listing, initiating, and replaying DQ run plans

Project description

dq-made-easy-cli

Standalone CLI package for rule onboarding, run plan management, and execution tracking in dq-made-easy.

Commands

dq-onboard — Workspace Rule Onboarding

Discover, filter, and bulk-submit rule onboarding proposals based on template matching.

dq-onboard --workspace "Retail Banking" --all --insecure --submit

Features:

  • Fetch workspace scope summary (attribute counts)
  • Generate template-based rule proposals
  • Filter by template type or select all
  • Preview with --dry-run or submit with --submit
  • JSON output for automation

📖 Full Documentation: ONBOARDING.md

Verified Examples (Retail Banking workspace: 157 attributes, 356 proposals):

  • View single sample proposal: dq-onboard --workspace "Retail Banking" --dry-run
  • Filter to NULL checks (157): dq-onboard --workspace "Retail Banking" --template "NULL Value" --all --dry-run
  • Submit all proposals: dq-onboard --workspace "Retail Banking" --all --submit
  • JSON output: dq-onboard --workspace "Retail Banking" --json --dry-run | jq .

dq-run-plan — Execution & Replay

List, initiate, replay, and export run plans (existing command).

dq-run-plan --help

dq-mcp-server — Agent Tools via MCP

Runs a stdio MCP server that exposes three tools backed by canonical dq-api routes:

  • validate_dataset -> POST /api/rulebuilder/v1/rules/validate/batch
  • get_anomalies -> GET /api/rulebuilder/v1/deliveries/{delivery_id}/exception-summary
  • trigger_remediation -> POST /api/rulebuilder/v1/incidents
dq-mcp-server --base-url http://localhost:8000/api --token "$DQ_MCP_API_TOKEN"

Environment variables:

  • DQ_MCP_API_BASE_URL (required unless --base-url is provided)
  • DQ_MCP_API_TOKEN (optional bearer token)
  • DQ_MCP_API_TIMEOUT_SECONDS (required unless --timeout-seconds is provided)

The server fails fast if base URL or timeout are missing.


Installation

pip install dq-made-easy-cli

Or from source:

cd dq-cli
pip install -e .

Verify both commands are available:

dq-onboard --help
dq-run-plan --help
dq-mcp-server --help

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

dq_made_easy_cli-0.6.4-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file dq_made_easy_cli-0.6.4-py3-none-any.whl.

File metadata

File hashes

Hashes for dq_made_easy_cli-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3faa724fb21b76fb266650c35348842e27cd350629d39ed48992d773c926114a
MD5 6d79063da6d6a00da4948b83c5e998e2
BLAKE2b-256 a409bfbba127e05b7c0977412c81a79afc712259ebd95b0bc62d5a83079a05d4

See more details on using hashes here.

Supported by

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