Python Template Project

This is a small template repository for creating python projects with a modern toolchain. The repository includes support for the following tools:

• poetry - package management and build system
• pytest - unit tests
• black - code linting

Getting started

Install poetry

# Install poetry
pip3 install --user poetry

Configure the project environment

# Set the Python version
poetry env use <python_version>

# Validate the environment configuration
poetry env info

Install dependencies and build the project

# Install dependencies
poetry install

# Build the project
poetry build

# Add new packages
poetry add <package-name>

Running unit tests

poetry run pytest

Other uses

Managing the project environment

poetry env info

poetry env remove

Activate the project environment in a shell

poetry shell

Removing dependencies

poetry remove <package>