counterweight/data-dwh-dbt-project
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

couple of small readme details

Browse source
This commit is contained in:
Pablo Martin 2024-05-29 11:27:21 +02:00
parent e9af710ae8
commit 4e5424b3b6
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -10,18 +10,20 @@ Welcome to Superhog's DWH dbt project. Here we model the entire DWH.
- You need a Linux environment. That can be Linux, macOS or WSL. - You need a Linux environment. That can be Linux, macOS or WSL.
- You need to have Python `>=3.10` installed. - You need to have Python `>=3.10` installed.
- All docs will assume you are using VSCode. - All docs will assume you are using VSCode.
- Also install the following VSCode Python extension: ms-python.python
- Prepare networking - Prepare networking
- You must be able to reach the DWH server through the network. There are several ways to do this. - You must be able to reach the DWH server through the network. There are several ways to do this.
- The current recommended route is to use the data VPN. You can ask Pablo to help you set it up. - The current recommended route is to use the data VPN. You can ask Pablo to help you set it up.
- Set up - Set up
- Create a virtual environment for the project with `python3 -m venv venv`. - Create a virtual environment for the project with `python3 -m venv venv`.
- It's recommended that you set up the new `venv` as your default interpreter for VSCode. To do this, click Ctrl+Shift+P, and look for the `Python: Select interpreter` option. Choose the new `venv`.
- Activate the virtual environment and run `pip install -r requirements.txt` - Activate the virtual environment and run `pip install -r requirements.txt`
- Create an entry for this project `profiles.yml` file at `~/.dbt/profiles.yml`. You have a suggested template at `profiles.yml.example` - Create an entry for this project `profiles.yml` file at `~/.dbt/profiles.yml`. You have a suggested template at `profiles.yml.example`
- Make sure that the `profiles.yml` host and port settings are consistent with whatever networking approach you've taken. - Make sure that the `profiles.yml` host and port settings are consistent with whatever networking approach you've taken.
- Run `chmod 600 ~/.dbt/profiles.yml` to secure your profiles file. - Run `chmod 600 ~/.dbt/profiles.yml` to secure your profiles file.
- Run `dbt deps` to install dbt dependencies - Run `dbt deps` to install dbt dependencies
- Check - Check
- Ensure you are running in the project venv, either by setting VSCode Python interpreter to the one created by `poetry`, or by running `poetry shell` in the console when in the root dir. - Ensure you are running in the project venv.
- Run `dbt debug`. If it runs well, you are all set. If it fails, there's something wrong with your set up. Grab the terminal output and pull the thread. - Run `dbt debug`. If it runs well, you are all set. If it fails, there's something wrong with your set up. Grab the terminal output and pull the thread.
- Complements - Complements
- If you are in VSCode, you most probably want to have this extension installed: [dbt Power User](https://marketplace.visualstudio.com/items?itemName=innoverio.vscode-dbt-power-user) - If you are in VSCode, you most probably want to have this extension installed: [dbt Power User](https://marketplace.visualstudio.com/items?itemName=innoverio.vscode-dbt-power-user)