Install Dependencies

Set up a Virtual Environment

It is always a good idea to set up dedicated Virtual Environment when you are developing a Python application. If you use uv or Poetry, this will be done automatically for you.

Otherwise, Pyenv has a virtualenv plugin which is very easy to use.

Also, check out this freeCodeCamp tutorial or a similar RealPython one for some great info. If you are going this (oldschool!) way, I'd recommend using Virtualenv instead of the built in venv tool (which is a subset of this).

Install required Dependencies

The project has been set up using uv to organize and install dependencies. If you have uv installed, simply run the following to install all that is needed.

$ uv sync

If you do not (or cannot) have uv installed, I have provided an auto-generatedrequirements.txt` in the project root which you can use as normal:

$ pip install -r requirements.txt

The above will install production dependencies only. If you want to install development dependencies as well, use the following instead:

$ pip install -r requirements-dev.txt

$ python app/api-admin.py

I definately recommend using uv if you can though, it makes dealing with updates and conflicts very easy.

If using uv or another virtual environment, you now need to activate the VirtualEnv:

$ source .venv/bin/activate

Under Windows, the command is slightly different:

$ .venv\Scripts\activate

Install Git Pre-Commit hooks

This stage is optional but recommended (however it is compulsory if you are submitting a Pull Request).

$ pre-commit install
pre-commit installed at .git/hooks/pre-commit

This will ensure that all code meets the required linting standard before being committed.

Run pre-commit manually

You can run these checks manually on all files using the below command :

$ poe pre