lumiai / python-best-practices-cookiecutter

Python best practices project cookiecutter 🍪

Python Best Practices Cookiecutter

Best practices cookiecutter template as described in this blogpost.

Features

• Testing with pytest
• Formatting with black
• Import sorting with isort
• Static typing with mypy
• Linting with flake8
• Git hooks that run all the above with pre-commit
• Deployment ready with Docker
• Continuous Integration with GitHub Actions

Quickstart

# Install pipx if pipenv and cookiecutter are not installed
python3 -m pip install pipx
python3 -m pipx ensurepath

# Install pipenv using pipx
pipx install pipenv

# Use cookiecutter to create project from this template
pipx run cookiecutter gh:sourcery-ai/python-best-practices-cookiecutter

# Enter project directory
cd <repo_name>

# Initialise git repo
git init

# Install dependencies
pipenv install --dev

# Setup pre-commit and pre-push hooks
pipenv run pre-commit install -t pre-commit
pipenv run pre-commit install -t pre-push