PiperRider CLI
Project description
PipeRider: Data Reliability Toolkit
What's PipeRider?
PipeRider is a light-weight data reliability toolkit using warehouse-native profiling so you can have a full understanding of your data
We're in an early stage, so let us know if you have any questions, feedback, or need help installing PipeRider! :heart:
Profiling as a data reliability strategy
PipeRider will make your life easier by:
- Building a data profile so you can easily understand your data
- Creating test suggestions based on the profiling
- Comparing data profile reports, so you track changes over time
Read how to implement a data quality strategy using profiling + testing
Made for the modern data team
For data engineers
- :zap: 2 min install & set-up
- :relieved: Non-intrusive & open-source: install and use locally
- :money_with_wings: Fast & cheap: 100M rows & 8 columns (or 50M & 16 columns) takes only 18s to profile
- :ledger: Cloud DataWarehouse native & auto-config for dbt
For data analysts
- :bowtie: Never waste time on analyzing wrong data: collects various metadata metrics such as freshness, uniqueness, distribution... check all metrics
- :speech_balloon: Communicate easily your data expectations by showing the report
- Zero-config dbt integration
Live Demo
Click here or on image to interact
Key features
- Generate an HTML Report featuring your data profile and data assertion test results (interactive sample)
- Compare two reports to understand how your data has changed over time (interactive sample)
- Test your data with data assertions:
- Built-in data assertions
- Extensible through custom assertions
- Auto-generated data assertions
- Currently supports Postgres, Snowflake, SQLite, BigQuery, Redshift, DuckDB, CSV and Parquet.
- Zero-config support for dbt projects
- Automation through GitHub Actions, save reports in S3
Getting started
Get started quickly below, go to the docs, or check out this article on how to add data observability using PipeRider
Install PipeRider
pip install piperider
By default, PipeRider supports built-in SQLite connector, extra connectors are available:
connectors | install | supported since |
---|---|---|
snowflake | pip install 'piperider[snowflake]' | |
postgres | pip install 'piperider[postgres]' | |
bigquery | pip install 'piperider[bigquery]' | PipeRider v0.7.0 |
redshift | pip install 'piperider[redshift]' | PipeRider v0.7.0 |
parquet | pip install 'piperider[parquet]' | PipeRider v0.8.0 |
csv | pip install 'piperider[csv]' | PipeRider v0.8.0 |
duckdb | pip install 'piperider[duckdb]' | PipeRider v0.8.0 |
Use comma to install multiple connectors in one line:
pip install 'piperider[postgres,snowflake]'
You can follow the quick start guide to learn more about PipeRider.
Attach PipeRider to a dbt project
Initialize PipeRider inside a dbt project and your data source settings will be automatically configured
piperider init
creates /.piperider
under a dbt project root and generates necessary configurations.
Scan data quality from models
piperider run
scans the models from data sources and creates assessment results in /.piperider/output
Generate reports
piperider generate-report
generate a static HTML report.
Generate comparison view
You can use piperider compare-report
to compare 2 reports.
Learn More
PipeRider Resources | Description |
---|---|
Documentation | PipeRider Main Doc Site |
Sample_Project | Sample Project with with sqlite |
dbt_Sample_Project | Sample Project with dbt |
Roadmap | PipeRider Roadmap |
Blog | How we got started |
Get involved
Support
If you like what we are building, support us! Give us a :star: or get in touch. We'd love your feedback! Send us a message on piperider.io, join our Discord, or report an issue on GitHub
Contributions
We welcome contributions. See the Set up dev environment and the Contributing guildline to get started.
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
File details
Details for the file piperider-nightly-0.10.0.20220922.tar.gz
.
File metadata
- Download URL: piperider-nightly-0.10.0.20220922.tar.gz
- Upload date:
- Size: 3.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8256e584f54ce7a640b771210a907f2db3d39196eb089d7c7e6580e7270dc07 |
|
MD5 | 9eb30ac72ee11fe9ea3c9bc0d7adbed2 |
|
BLAKE2b-256 | 94db48c85545e7476d7421e3402102392ff3fd5e277c23f7e6e3bfe7ccf3fd30 |
File details
Details for the file piperider_nightly-0.10.0.20220922-py3-none-any.whl
.
File metadata
- Download URL: piperider_nightly-0.10.0.20220922-py3-none-any.whl
- Upload date:
- Size: 3.7 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec1dd77bca2f6c989d7688cc8669f150fd61059625897676d78f4d9b31fb4ae4 |
|
MD5 | 1fe00d6597b43d3819e896275ca60c69 |
|
BLAKE2b-256 | 6604c1a609bd20d5b2c2195143be2206c2c5e4a2895ae0c3bbed6b486c7f1dbd |