Sifflet CLI
Project description
Sifflet CLI
This package provides a command line interface (CLI) to Sifflet application.
Getting Started
Installation
Sifflet CLI is compatible with Python version 3.7 or greater
pip install sifflet
sifflet --version
Configuration
Before using the Sifflet CLI, you need to set your tenant and credentials. You can do it in several ways:
- Sifflet command line
sifflet configure
(which will persists configuration in a file) - Or with environment variables
You will need in both cases the following information:
<access_token>
: you can find more information on how to generate it here- For SaaS version:
<tenant_name>
: Name of your tenant. Sifflet UI URL ishttps://<tenant_name>.siffletdata.com
. Sifflet Backend URL ishttps://<tenant_name>api.siffletdata.com
. For instance, if you access to Sifflet UI withhttps://mycompany.siffletdata.com
, then your tenant would bemycompany
. - For self-hosted deployment:
<backend_url>
: Full URL to the Sifflet backend on your deployment including for instance:https://sifflet-backend.mycompany.com
Sifflet configure
You can input the tenant and credentials directly with the sifflet configure
command.
For SaaS version:
> sifflet configure --tenant <tenant_name>
Your API access token [None]: <access_token>
or, for self-hosted deployment:
> sifflet configure --backend-url <backend_url>
Your API access token [None]: <access_token>
The use of sifflet configure
will persist the configuration in a file located at ~/.sifflet/config.ini
(or in %UserProfile%\.sifflet/config.ini
on Windows).
Environment variables
To use environment variables, you can do the following:
For SaaS version:
> export SIFFLET_TENANT=<tenant_name>
> export SIFFLET_TOKEN=<access_token>
or, for self-hosted deployment:
> export SIFFLET_BACKEND_URL=<backend_url>
> export SIFFLET_TOKEN=<access_token>
You can check that setup is done correctly with sifflet status
.
> sifflet status
Sifflet version = x.x.x
Tenant = my_tenant
Tenant is up and reachable
Token expiration date = 2024-01-01 00:00:00
Token is valid with scope API
Status = OK
If you encounter any error at this step, please check your tenant and token configurations.
Documentation
The documentation with the available commands can be found here.
Help
The --help
option is available for any command, for instance sifflet --help
or sifflet rules list --help
.
Examples
Trigger a specific rule
- First, find your rule id with
sifflet rules list
. You can filter with--name
to narrow your search.
# Display rules
sifflet rules list
sifflet rules list --name <search_criteria>
- Then you can trigger one of several rules with
sifflet rules run
# Run one or many rules
sifflet rules run --id <rule_id>
sifflet rules run --id <rule_id_1> --id <rule_id_2> --id <rule_id_3>
- Finally, retrieve the run status of a rule with
sifflet rules run_history
# Display rule runs history for a given rule id
sifflet rules run_history --id <rule_id>
Send dbt artifacts
If you have already added the datasource to Sifflet, you can then send the dbt artifacts for syncing the data.
# send the dbt artifacts
sifflet ingest dbt --project-name <project_name> --target <target> --input-folder <dbt_artifacts_directory>
Contact
For any queries, you can reach us at contact@siffletdata.com
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.