Python Project Template

A simple template for Python projects with boilerplate workflows setup:

• Empty Python app structure
• Basic pytest setup
• Makefile (see below for commands)
• pre-commit configuration
• Static type checking with mypy
• GitHub Actions runner for flake8 and pytest
• Pull request template

Using this template

To get started with this template, simply click the "Use this template" button on GitHub (not fork). For more information on using template repos you can read the docs.

---

My Project

Developing

After cloning the repo, start by creating a virtual environment, activating it and installing dev requirements:

# 1. Create virtual environment
python -m venv venv

# 2. Activate virtual environment
source venv/bin/activate  # Linux/Mac
.\venv\Scripts\activate   # Windows

# 3. Install dev requirements
make install-dev

Make Commands

• make install - Installs app requirements
• make install-dev - Installs app and development requirements
• make run - Runs main.py
• make test - Runs unit tests
• make check-types - Runs mypy static type checking

---

Created using Iain530's Python Project Template