Python Template

Basics

A template repository for python projects with:

• Poetry
• Linters (flake8, wemake-style-guide, mypy)
• Formatters (black, autoflake)
• Pre-commit
• Pytest

How to use

Click "use this template" on the top right of the main repository page and create a new repository from this one. After that you can work on your new repository as usual. I'd recommend searching all TODO comments in the resulting repository and completing them

Install

# TODO set to your poetry version
pip install poetry==1.8.2
poetry install
pre-commit install

Additions

Docker

Here is a template dockerfile for python /w poetry:

FROM python:3.12-alpine

# TODO change to any directory
WORKDIR /app
RUN pip install --upgrade pip

# TODO set to your poetry version
RUN pip install poetry==1.8.2
RUN poetry config virtualenvs.create false

COPY pyproject.toml poetry.lock ./
RUN poetry install --no-interaction --no-ansi --only main

# TODO `COPY` your project files

# TODO set the ENTRYPOINT and/or CMD

Docker Compose

And a template docker-compose file:

services:
  app:
    # depends_on:
    #   database: 
    #     condition: service_healthy
    build:
      context: .
      dockerfile: Dockerfile
    # image:
    restart: always
    # command: ...
    # ports:
    #   - target: 8000
    #     host_ip: 127.0.0.1
    #     published: 8000
    # volumes:
    #   - type: bind  # TODO you can pass source files for fast-reload
    #     source: <SOURCE>
    #     target: /<WORKDIR>
    # environment:
    #   SECRET: local