Add readme instructions

Author: MathyouMB

README.md

@@ -2,61 +2,92 @@
 
 *Description coming soon.*
 
-## 1. Install Dependencies
+## Setup Instructions
+
+1. Install Ollama
 
 ```bash
-pip install -r requirements.txt
+brew install ollama
 ```
 
-## 2. Set Up Ollama LLM
-
-Start the Ollama server and pull the required model:
+2. Pull the Mistral model
 
 ```bash
 ollama serve
 ollama pull mistral
-ollama run mistral
 ```
 
-## 3. Set Up the Database
+3. Install Docker
 
-Run Alembic to create and apply database migrations:
+Install Docker Desktop: https://www.docker.com/products/docker-desktop/
 
 ```bash
-alembic -c src/infrastructure/db/alembic.ini revision --autogenerate -m "initial migration"
-alembic -c src/infrastructure/db/alembic.ini upgrade head
+brew install docker-compose
+```
+
+4. Run Docker Compose
+
+```bash
+docker-compose up
 ```
 
-> Make sure your database connection URL is properly configured in `src/infrastructure/db/alembic.ini` and your SQLAlchemy settings.
+5. Install More Stuff
+
+```bash
+brew install libpq && brew link --force libpq
+brew install openssl@3
+```
 
-## 4. Run Celery Worker
+6. Create a virtual environment
 
-Start the Celery worker to process tasks:
+```bash
+python3 -m venv venv
+source venv/bin/activate
+```
 
-### Development (single-threaded)
+7. Install dependencies
 
 ```bash
-PYTHONPATH=src celery -A infrastructure.celery worker --loglevel=info --pool=solo
+env \
+  LDFLAGS="-L/opt/homebrew/opt/openssl@3/lib" \
+  CPPFLAGS="-I/opt/homebrew/opt/openssl@3/include" \
+  PKG_CONFIG_PATH="/opt/homebrew/opt/openssl@3/lib/pkgconfig" \
+  pip install -r requirements.txt
 ```
 
-### Production-like (multi-threaded)
+8. Run Migrations
 
 ```bash
-PYTHONPATH=src celery -A services.celery worker --pool=threads --concurrency=12
+alembic -c src/infrastructure/db/alembic.ini upgrade head
 ```
 
-## 5. Running Tests
 
-Run the full test suite using Pytest:
+## Run Data Ingestion
+
+In one terminal, activate your virtual environment and run Celery:
 
 ```bash
-PYTHONPATH=src pytest
+source venv/bin/activate
+PYTHONPATH=src celery -A config.celery worker --loglevel=info --pool=solo
 ```
 
-## 6. Updating `requirements.txt`
+Then in another terminal run the data ingestion script:
+
+```bash
+source venv/bin/activate
+make post-deploy
+```
 
-After installing new packages, freeze your environment:
+## Run Dev CLI
 
 ```bash
-pip freeze > requirements.txt
+source venv/bin/activate
+make dev-cli
 ```
+
+## Run Tests
+
+```bash
+source venv/bin/activate
+make test
+```

pyproject.toml

@@ -1,8 +1,9 @@
 [tool.black]
 line-length = 88
-target-version = ["py312"]
+target-version = ["py311"]
 exclude = '''
 (
-    infrastructure/db/versions/781a41a2f89f_init\.py
+    venv
+    | infrastructure/db/versions/781a41a2f89f_init\.py
 )
 '''