Skip to content

Commit

Permalink
chore: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chenxuanrong committed May 10, 2023
1 parent 60cd914 commit eabb10b
Showing 1 changed file with 21 additions and 26 deletions.
47 changes: 21 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,6 @@
Data reliability tool for profiling and testing your data
</p>

[![ci-tests](https://github.com/infuseai/piperider-cli/actions/workflows/tests.yaml/badge.svg)](https://github.com/infuseai/piperider-cli/actions/workflows/tests.yaml/badge.svg)
[![release](https://img.shields.io/github/release/infuseAI/piperider-cli/all.svg?style=flat-square)](https://github.com/infuseAI/piperider-cli/releases)
[![pipy](https://img.shields.io/pypi/v/piperider?style=flat-square)](https://pypi.org/project/piperider/)
[![python](https://img.shields.io/pypi/pyversions/piperider?style=flat-square)](https://pypi.org/project/piperider/)
[![downloads](https://img.shields.io/pypi/dw/piperider?style=flat-square)](https://pypi.org/project/piperider/#files)
[![license](https://img.shields.io/github/license/infuseai/piperider?style=flat-square)](https://github.com/InfuseAI/piperider/blob/main/LICENSE)
[![InfuseAI Discord Invite](https://img.shields.io/discord/664381609771925514?color=%237289DA&label=chat&logo=discord&logoColor=white&style=flat-square)](https://discord.com/invite/5zb2aK9KBV)

<p align="left">
<a href="https://docs.piperider.io/" alt="documentation site" title="Piperider Documentation"> Docs </a> |
<a href="https://github.com/orgs/InfuseAI/projects/1/views/1" alt="product roadmap" title="Planned Features/Changes"> Roadmap </a> |
<a href="https://discord.com/invite/5zb2aK9KBV"> Discord </a> |
<a href="https://blog.infuseai.io/data-reliability-automated-with-piperider-7a823521ef11"> Blog </a>
</p>

# Table of Contents

Expand Down Expand Up @@ -55,30 +41,41 @@ Piperider is a CLI tool that allows you to build data profiles and write asserti
- **Generates comparison reports** to visualize how your data has changed over time ([example](https://piperider-github-readme.s3.ap-northeast-1.amazonaws.com/comparison-0.16.0/index.html))
- **Supported Datasources**: Snowflake, BigQuery, Redshift, Postgres, SQLite, DuckDB, CSV, Parquet.


# Quickstart

This repo is a fork version of piperider package that includes `reconcile` feature.

## Get Started

Create a [github personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)

## Installation

```bash
pip install piperider
pip install "piperider @ git+https://${GITHUB_USER}:${GITHUB_TOKEN}@github.com/chenxuanrong/piperider@domain"

# To install database drives
pip install "piperider[snowflake] @ git+https://${GITHUB_USER}:${GITHUB_TOKEN}@github.com/chenxuanrong/piperider@domain"

```

By default, PipeRider supports built-in SQLite connector, extra connectors are available:

| connectors | install |
| ---------- | ------------------------------------ |
| snowflake | `pip install 'piperider[snowflake]'` |
| postgres | `pip install 'piperider[postgres]'` |
| bigquery | `pip install 'piperider[bigquery]'` |
| redshift | `pip install 'piperider[redshift]'` |
| parquet | `pip install 'piperider[parquet]'` |
| csv | `pip install 'piperider[csv]'` |
| duckdb | `pip install 'piperider[duckdb]'` |
| snowflake | `pip install 'piperider[snowflake] @GITHUB_REPO'` |
| postgres | `pip install 'piperider[postgres]' @GITHUB_REPO` |
| bigquery | `pip install 'piperider[bigquery]' @GITHUB_REPO` |
| redshift | `pip install 'piperider[redshift]' @GITHUB_REPO` |
| parquet | `pip install 'piperider[parquet]' @GITHUB_REPO` |
| csv | `pip install 'piperider[csv]' @GITHUB_REPO` |
| duckdb | `pip install 'piperider[duckdb]' @GITHUB_REPO` |

Use comma to install multiple connectors in one line:

```bash
pip install 'piperider[postgres,snowflake]'
pip install 'piperider[postgres,snowflake] @@GITHUB_REPO'
```

## Initialize Project & Diagnose Settings
Expand Down Expand Up @@ -193,6 +190,4 @@ The result is saved to `.piperider/reconciles/latest/reconcile.json`

# Development

See [setup dev environment](DEVELOP.md) and the [contributing guildlines](CONTRIBUTING.md) to get started.

**We're in an early stage, so [let us know](mailto:[email protected]) if you have any questions, feedback, or need help trying out PipeRider! :heart:**
See [setup dev environment](DEVELOP.md) and the [contributing guildlines](CONTRIBUTING.md) to get started.

0 comments on commit eabb10b

Please sign in to comment.