Skip to main content

CLI companion tool to support dq-tools package

Project description

diqu

PyPI version python-cli License: MIT python

CLI companion tool supporting the Alert / Notification for dq-tools

Installation

pip install diqu [--upgrade]

Usage

dbt run -s dq_tools
diqu alert \
  --project-dir /path/to/dbt/project \
  --to slack --to jira
Sample logs
04:33:17  diqu: INFO - Run with diqu==1.0.0 🏃
04:33:19  diqu: INFO - Using dbt project at: /path/to/dbt/project
04:33:19  diqu: INFO - Using dbt profiles.yml at: ~/.dbt
04:33:19  diqu: INFO - Using snowflake connection
04:33:19  diqu: INFO - Looking for the query in: /path/to/site-packages/diqu/packages/include/dq_tools__get_test_results.sql
04:33:23  diqu: INFO - Alerting to channel: SLACK
04:33:23  diqu: INFO - ✅ Done > Slack
04:33:23  diqu: INFO - Alerting to channel: JIRA
04:33:23  diqu: INFO - ✅ Done > JIRA

In particular to the alert module, here are the additional configurations:

  • For SLACK, you need to use the environment variables to configure the Slack Channel:

    export SLACK_TOKEN=your_token
    export SLACK_CHANNEL=your_channel_name
    diqu alert --to slack
    
  • For JIRA, you need to use the environment variables to configure the JIRA Board:

    export JIRA_SERVER=your_jira_server e.g. https://your_value.atlassian.net/
    export JIRA_AUTH_USER=your_service_account e.g. dqt_user@your_value.com
    export JIRA_AUTH_PASSWORD=your_service_token e.g. ATATTxxxxx
    export JIRA_PROJECT_ID=your_project_id e.g. 106413
    diqu alert --to jira
    

How to Contribute

See CONTRIBUTING.md

About Infinite Lambda

Infinite Lambda is a cloud and data consultancy. We build strategies, help organisations implement them and pass on the expertise to look after the infrastructure.

We are an Elite Snowflake Partner, a Platinum dbt Partner and two-times Fivetran Innovation Partner of the Year for EMEA.

Naturally, we love exploring innovative solutions and sharing knowledge, so go ahead and:

🔧 Take a look around our Git
✏️ Browse our tech blog

We are also chatty, so:
#️⃣ Follow us on LinkedIn
👋🏼 Or just get in touch

About IL

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

diqu-0.0.3.tar.gz (12.3 kB view hashes)

Uploaded Source

Built Distribution

diqu-0.0.3-py3-none-any.whl (18.6 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