From 9415eeeda79bdce687abbb1bf3ae368010d5600e Mon Sep 17 00:00:00 2001 From: Fernando Brito Date: Tue, 10 Aug 2021 13:49:27 +0200 Subject: [PATCH] docs: update README --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4050a76..94843c8 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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