Skip to content

Commit

Permalink
Merge pull request #7 from voi-oss/improve-readme
Browse files Browse the repository at this point in the history
docs: update README
  • Loading branch information
fernandobrito authored Aug 10, 2021
2 parents b51b062 + 9415eee commit 592b820
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,18 @@ are supported as a source.
> Please reach out if you try this at your own organization. Feedback is very appreciated, and we
> would love to hear if you had any issues setting this up at your own.
## Installation

This project requires Python 3.8+. It has only been tested with dbt 0.19, Tableau Server 2021.1 and Snowflake SQL
dialect.

You can install the latest version of this package from PyPI by running the command below. Usage instructions can be
found further below in this document.

```shell
$ pip install dbt-exposures-crawler
```

## Motivation

[dbt](https://www.getdbt.com/) is an open-source tool to manage data transformations in SQL. It automatically generates
Expand Down Expand Up @@ -140,17 +152,6 @@ section below.
* For now, only Tableau workbooks (and not published data sources) are supported. Also, only Snowflake SQL is currently
supported.

## Installation

This project requires Python 3.9+. It has only been tested with dbt 0.19, Tableau Server 2021.1 and Snowflake SQL
dialect.

Over the coming weeks we will have it published on PyPI and you will be able to install it by:

```shell
$ pip install dbt-exposures-crawler
```

## Usage

Internally, we use this automation as part of our dbt docs release pipeline. We have a GitHub Action that does the
Expand Down

0 comments on commit 592b820

Please sign in to comment.