Fix Readme and add some additional make commands

.gitignore

@@ -1,5 +1,5 @@
 .env
-venv
+*venv
 .log
 __pycache__
 .pytest_cache

Makefile

@@ -2,6 +2,11 @@ DOCKER_IMAGE_NAME=test_db_image
 DOCKER_CONTAINER_NAME=test_db_container
 DB_PORT=5432
 
+# Might be worth using poetry here so you can install packages in the venv and then
+# set the shell.
+setup-venv:
+	python -m venv .venv
+
 install:
 	pip install -r requirements.txt
 
@@ -13,11 +18,16 @@ daemon:
 
 test_db:
 	docker build -t $(DOCKER_IMAGE_NAME) -f Dockerfile.test_db .
-	docker run -d --name $(DOCKER_CONTAINER_NAME) -p $(DB_PORT):$(DB_PORT) -v ${PWD}/database/00_legacy_tables.sql:/docker-entrypoint-initdb.d/00_legacy_tables.sql -v ${PWD}/database/01_table_creation.sql:/docker-entrypoint-initdb.d/01_table_creation.sql $(DOCKER_IMAGE_NAME)
+	docker run -d --name $(DOCKER_CONTAINER_NAME) \
+	-p $(DB_PORT):$(DB_PORT) -v ${PWD}/database/00_legacy_tables.sql:/docker-entrypoint-initdb.d/00_legacy_tables.sql \
+	-v ${PWD}/database/01_table_creation.sql:/docker-entrypoint-initdb.d/01_table_creation.sql $(DOCKER_IMAGE_NAME)
 
 stop_test_db:
 	docker stop $(DOCKER_CONTAINER_NAME) || true
 	docker rm $(DOCKER_CONTAINER_NAME) || true
 	docker rmi $(DOCKER_IMAGE_NAME) || true
 
+unittest:
+	pytest tests/unit
+
 .PHONY: install imbalances daemon test_db run_test_db stop_test_db clean

README.md

@@ -1,10 +1,31 @@
 # token-imbalances
 
-This script is to calculate the raw token imbalances before and after a settlement.
+This repository is to calculate the raw token imbalances before and after a settlement.
 The raw token imbalances are stored in the raw_token_imbalances table.
 Additionally, coingecko prices for fetchable token addresses at the time of transaction are stored in the coingecko_prices table. These tables are a part of the Solver Slippage Database.
 These prices can be used to convert raw imbalances to ETH.
 
+## Env Setup
+
+### Docker
+This repo uses Docker, but you could potentially use another another container management service like podman, see docs [here](https://podman.io/docs)
+For docker installation go to the [docker website](https://docs.docker.com/get-started/get-docker/)
+
+### Python
+Install python if you don't have it already, current version is 3.12+
+[Installation instructions](https://realpython.com/installing-python/)
+
+For managing different versions of python you could look at using [pyenv](https://github.com/pyenv/pyenv).
+
+There will need to be some env variables that you need to set like `CHAIN_SLEEP_TIME`, you can set those in a .env file. View the sample .env.sample file to see what you might need to set. 
+
+Once python has been set up and your env file is populated you can then proceed with the next set up instructions:
+
+**Set up virtual environment:**
+```sh
+python -m venv .venv
+source .venv/bin/activate
+```
 
 **Install requirements from root directory:**
 ```bash
@@ -25,9 +46,41 @@ python -m src.daemon
 ```
 
 ## Tests
+*Note: Make sure docker is installed and the daemon is running so you can execute this* 
 
 To build and start a local database for testing use the command
 ```sh
 docker build -t test_db_image -f Dockerfile.test_db .
-docker run -d --name test_db_container -p 5432:5432 test_db_image
+docker run -d --name test_db_container -p 5432:5432 -v ${PWD}/database/00_legacy_tables.sql:/docker-entrypoint-initdb.d/00_legacy_tables.sql -v ${PWD}/database/01_table_creation.sql:/docker-entrypoint-initdb.d/01_table_creation.sql test_db_image
+
+```
+
+To run the unittests you can use the make target unittest `make unittest`, however you might have a couple issues:
+- You might run into the issue of the binary package for psycopg not being installed simply run:
+```sh
+pip install "psycopg[binary,pool]"
+```
+
+To shutdown the docker test db and remove the image/container you can do:
+
+```sh
+	docker stop test_db_container || true
+	docker rm test_db_container || true
+	docker rmi test_db_image || true
+```
+
+## Using the Makefile
+
+You can do all of the above also by running the make commands:
+
+```sh
+make install
+
+make imbalances
+
+make test_db
+
+make stop_test_db
+
+make unittest
 ```