Skip to content

Commit

Permalink
improving readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nobert-mumo committed Jan 10, 2025
1 parent f874044 commit 4553356
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ Contains dbt models for transformations in the DWH

## Setting up locally
### Requirements
1. Make sure you have python installed: Python 3.8 and above. You can get this from https://www.python.org/downloads/release/python-380/
1. Make sure you have python installed: Python 3.8 and above. You can get this from https://www.python.org/downloads/release/python-380/. Recommended you install with the 'Install for all users' option
- Be sure to check this: https://docs.getdbt.com/faqs/Core/install-python-compatibility matrix to see the compatibility of various python versions with the available dbt versions
2. For Windows preferably use Git Bash as your terminal. Download the git package here https://gitforwindows.org/ (It will include git bash)
3. Make sure you have a PostgreSQL client to interact with your PostgreSQL database e.g PgAdmin, DBeaver, Azure Data Studio etc

### Steps
- Clone the repo from GitHub and cd to the root folder`
- Create a python virtual environment by running: `python -m venv <name_of_environemt>` (e.g. `python venv venv`)
- Create a python virtual environment by running: `python -m venv <name_of_environemt>` (e.g. `python -m venv venv`)
- Activate virtual environment by running: `source venv/Scripts/activate`
- Once virtual environment is activated make sure you are using the latest pip by running:
`python -m pip install --upgrade pip`
Expand All @@ -20,7 +20,7 @@ Contains dbt models for transformations in the DWH
- Make sure that the libraries install succesfully without any errors
- After installing run version check to confirm dbt is installed in your virtual environment
`dbt --version`
- Create a `.env` file on the root folder and paste the following environment variables (make sure there is no space between):
- Create a `.env` file on the root folder and paste the following environment variables. Replace the < strings > with the actual values(make sure there is no space between the equal sign):

```
export DBT_USER_DEV=<postgres user>
Expand All @@ -32,10 +32,10 @@ Contains dbt models for transformations in the DWH
export DBT_PROFILES_DIR=./profiles/
```
For DBT_SCHEMA make sure you have a schema in the development Postgres instance that you will use to build your models & datasets. Ideally call it
For DBT_SCHEMA make sure you have a schema in the development PostgreSQL instance that you will use to build your models & datasets. Ideally call it
*dbt_<name_of_dev>*
- Run `source .env` to load your environment variables.
- Make sure you have the config file `profiles.yml` inside the profiles folder with the following configarations:
- Make sure you have a config file `profiles.yml` inside the profiles folder with the following configarations:
```
palladium_kenya_analytics:
Expand Down

0 comments on commit 4553356

Please sign in to comment.