Skip to content

Commit

Permalink
add setup task and docs into a table
Browse files Browse the repository at this point in the history
  • Loading branch information
ashrodan committed Sep 28, 2023
1 parent 87d8153 commit db57981
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,13 +137,14 @@ More install methods are [detailed in the Task docs](https://taskfile.dev/instal

Tasks included are:

```shell
task extract # pull data from github archive for the past day into the data/ directory
task load # load data from the data/ directory into duckdb
task transform # run the dbt transformations
task [*]-prod # all tasks can be run in a 'prod-mode' against a MotherDuck cloud warehouse
task bi # serve the Evidence project locally for development
```
| Task | Description |
|----------|----------|
| `task setup` | Setups up all required tools to run the stack |
| `task extract` | pull data from github archive for the past day into the data/ directory |
| `task load` | load data from the data/ directory into duckdb |
| `task transform` | run the dbt transformations |
| `task [*]-prod` | all tasks can be run in a 'prod-mode' against a MotherDuck cloud warehouse |
| `task bi` | serve the Evidence project locally for development |

### 🐍 Running the EL script directly 🏗️

Expand Down
7 changes: 6 additions & 1 deletion Taskfile.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
version: "3"

tasks:
setup:
- python -m venv .venv # Create a virtual environment
- source .venv/bin/activate # Activate the virtual environment
- python -m pip install -r requirements.txt
- dbt deps
- npm --prefix ./reports install
extract:
cmds:
- python3 el.py -e
Expand All @@ -15,7 +21,6 @@ tasks:
- python3 el.py -lp
transform:
cmds:
- dbt deps
- dbt build
transform-prod:
cmds:
Expand Down

0 comments on commit db57981

Please sign in to comment.