Home

Setup

This project uses python >= 3.11. To setup the project, run the following commands:

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

This will create a virtual environment in the .venv directory, activate it, and install the dependencies listed in requirements.txt.

If you are not familiar with developing python projects, virtual environment is a way to isolate the dependencies of a project from the system dependencies. This way, you can have different versions of the same package in different projects without any conflict. Read more about it here.

Virtual environment is activated per shell session. So, you need to run source .venv/bin/activate everytime you open a new terminal.

Then checkout document on the right for each stage of workshop