Add pre commit docs and setup script (#19)

* Add setup script

* Add .user.yml to .gitignore

.gitignore

@@ -14,3 +14,5 @@ env
 *.wal
 
 data/*.json.gz
+
+.user.yml

requirements.txt

@@ -1,5 +1,6 @@
 black~=23.9.1
 dbt-metricflow[duckdb]~=0.3.0
+duckdb~=0.8.1
 halo~=0.0.31
 isort~=5.12.0
 pre-commit~=3.4.0
@@ -8,4 +9,3 @@ ruff~=0.0.291
 sqlfluff-templater-dbt~=2.3.2
 sqlfluff~=2.3.2
 tqdm~=4.66.1
-duckdb~=0.8.1

setup.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+# This script will run all of the initial setup commands for the project
+# That said, we encourage you to run the commands one by one in the terminal
+# so that you can see what is happening and understand the process better
+
+# Set up a Python virtual environment
+python3 -m venv .venv
+
+# Activate the virtual environment
+source .venv/bin/activate
+
+# Upgrade pip
+python3 -m pip install --upgrade pip
+
+# Install the Python dependencies
+python3 -m pip install -r requirements.txt
+
+# Install the pre-commit hooks
+pre-commit install
+
+# Install the Node dependencies
+npm install --prefix ./reports
+
+# Install the dbt packages
+dbt deps