Python App Template

This project provides a starter structure and tooling for Python apps, aiming for a consistent and modern dev experience.

Read the full project documentation.

Installation

Requirements

• UV package manager, see Installing uv

Clone the repository

  git clone https://github.com/PierreLapolla/python_template.git
  cd python_template

Initialize your environment

  uv sync
  uv run pre-commit install

Running the project

To run the project locally, run the following command:

  uv run app

Docker

Build the image:

  docker build -t python-template .

Run the container:

  docker run --rm python-template

Tests, linting and formatting

  uv run pytest

  uvx ruff check . --fix

  uvx ruff format .

Run all hooks manually:

  uv run pre-commit run --all-files

Documentation

Preview the documentation locally with uv run zensical serve. The documentation site is automatically deployed to GitHub Pages when changes are pushed to main or master.

License

This project is licensed under the MIT LICENSE