Skip to content

Getting Started

This tutorial will guide you through setting up and running the Python Template project.

This project is intended to be used with nix and direnv. If you have these tools set up, simply opening a terminal in the project folder will perform all the necessary setup steps for you, including installing dependencies and pre-commit hooks :)

Steps

  1. Clone the repository: 
    git clone <repository-url>
cd python-template

If you are not using nix and direnv, follow these steps to setup the project

Steps

  1. Clone the repository: 

    git clone <repository-url>
cd python-template

  2. Create a virtual environment: 

    uv venv
source .venv/bin/activate

  3. Install dependencies: 

    uv pip install -r pyproject.toml --all-extras

  4. Install pre-commit hooks: 

    pre-commit install