Skip to content

Commit 77c1817

Browse files
committed
Changes in README to clarify setup and add personal information
1 parent df48f2d commit 77c1817

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

README.md

+22-11
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,38 @@
11
# dbt-data-quality
22
Data quality checks in your dbt flow.
33

4+
This repository helps you understand the different data quality checks available in [dbt](https://www.getdbt.com/).
5+
6+
You can clone the repository, create a `supabase` account, write the `.env` file and run the commands according to the environment setup, and get an environment where you can practice testing with dbt **for free**.
7+
8+
## Author
9+
I'm Bruno Gonzalez from 🇺🇾, working as a senior data engineer, and writing about data quality and data engineering.
10+
- [Substack](https://dataqualityguru.substack.com/)
11+
- [LinkedIn](https://www.linkedin.com/in/brunouy/)
12+
13+
## Tools
14+
Postgres database: [supabase](https://supabase.com/). Create a free account and get the credentials to create the `.env` file.
15+
416
## Environment setup
17+
Create `.env` file with the following structure:
18+
```
19+
POSTGRES_HOST=<postgres_host>
20+
POSTGRES_USER=<postgres_user>
21+
POSTGRES_PASSWORD=<postgres_password>
22+
POSTGRES_DATABASE=<postgres_database>
23+
```
24+
25+
Commands to setup the environment:
526
```
627
conda create -n dbtdq python=3.9
728
conda activate dbtdq
829
pip install -r requirements.txt
30+
export $(cat .env | xargs)
931
dbt seed
1032
dbt run
1133
dbt deps
1234
```
1335

14-
`.env` file structure:
15-
```
16-
POSTGRES_HOST=<postgres_host>
17-
POSTGRES_USER=<postgres_user>
18-
POSTGRES_PASSWORD=<postgres_password>
19-
POSTGRES_DATABASE=<postgres_database>
20-
```
21-
22-
## Tools
23-
Postgres database: [supabase](https://supabase.com/).
24-
2536
## Example
2637
Modified from dbt-labs [jaffle_shop](https://github.com/dbt-labs/jaffle_shop).
2738

0 commit comments

Comments
 (0)