Skip to content

💻 local dev setup

If you use codespaces or devcontainers, you don't need to set up a local development environment. But otherwise, follow these steps to set up some useful utilities.

Check the minimum required dependencies and install the tools you need.

🐧 Linux/WSL instructions

Minimum required dependencies:

Direnv

To load python virtual environments automatically and manage environment variables.

# Enter project
cd <project-folder>

# Install direnv
sudo apt update && sudo apt install direnv

# Add direnv to your shell
echo 'eval "$(direnv hook bash)"' >> ~/.bashrc  # if you use bash
echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc  # if you use zsh
eval "$(direnv hook bash)"  # add to current shell

# Add PDM support to direnv
mkdir -p ~/.config/direnv/
cp .devcontainer/direnvrc ~/.config/direnv/direnvrc
When you enter the project folder, direnv will ask you to allow the .envrc file to be loaded. Allow it by running direnv allow.

Pyenv

For installing and managing (multiple) python versions. You may want to use the system's version and not install pyenv.

Otherwise, follow these instructions.

  1. Install Python build dependencies: 
    sudo apt update && sudo apt install build-essential libssl-dev zlib1g-dev \
    libbz2-dev libreadline-dev libsqlite3-dev curl \
    libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev

  2. Install pyenv 

    curl https://pyenv.run | bash

  3. Set up your shell environment for Pyenv 

    # add env variables to your bash .profile (if you use bash)
echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.profile
echo 'command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.profile
echo 'eval "$(pyenv init --path)"' >> ~/.profile

# add shell integration to bash shell
echo 'eval "$(pyenv init -)"' >> ~/.bashrc

# add env variables to zsh's .zprofile (if you use zsh)
echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.zprofile
echo '[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.zprofile
echo 'eval "$(pyenv init --path)"' >> ~/.zprofile

# add shell integration to zsh shell
echo 'eval "$(pyenv init -)"' >> ~/.zshrc

  4. Install python versions 

    pyenv install 3.10
pyenv global 3.10

Pipx

For installing python packages in isolated environments.

sudo apt update && sudo apt install pipx
pipx ensurepath

PDM

To manage package dependencies and virtual environments.

pipx install pdm

Pre-commit

To run code formatting and linting before committing.

pipx install pre-commit

In your projects, you should enable pre-commit hooks by running: 

pre-commit install --install-hooks

Commitizen

To help with conventional commits.

pipx install commitizen
pipx inject commitizen cz-conventional-gitmoji  # installs emoji plugin

Copier

To create new repositories from cookie-doh.

pipx install copier