README.md

python-project-template

a simple template for organizing any python project.

setup & environment

this template is designed to streamline the setup of any python project. follow these steps to get started:

1. install uv

use uv to manage your virtual environments:

pip install uv

2. create a virtual environment

create an environment using python 3.10 (or your preferred version):

uv venv --python 3.10

3. activate the environment

activate the virtual environment:

source .venv/bin/activate

4. install dependencies

install all the required dependencies from the requirements.txt file:

uv pip install -e .

5. install pre-commits

pre-commit install

ready to code

you're now all set to start building your project.