Get your pre-commits setup right from the start

Pre-commits are a great tool to ensure there is some standard level of quality across the codebase and the commits. Its super easy to bypass if you are in a huge rush for any reason, so you may as well just add them to your codebase.

Quickstart

1. Install pre-commit: Already done if you followed the UV packaging guide
2. Create the .pre-commit-config.yaml file to specify our pre-commits
   • Collection of helpful small utilities
   • Linting, formatting and type checking with: ruff, black, isort, pylint, and mypy
3. Install the pre-commit environment
4. Run it to ensure it works (this will take longer the very first time as we install dependencies in the pre-commit enviroment)

cat <<EOF > .pre-commit-config.yaml
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.5.0  # Use the latest stable release
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-yaml
        args: ["--unsafe"]
      - id: check-added-large-files
      - id: check-case-conflict
      - id: check-merge-conflict
      - id: check-symlinks
      - id: check-executables-have-shebangs
      - id: check-json
      - id: detect-private-key
      - id: fix-byte-order-marker
      - id: mixed-line-ending
      - id: pretty-format-json
        args: ["--autofix"]
      - id: check-toml
  - repo: local
    hooks:
    - id: ruff
      name: ruff
      entry: uv run ruff check --config='pyproject.toml'
      language: system
      types: [python]
  - repo: local
    hooks:
    - id: black
      name: black
      entry: uv run black --config='pyproject.toml'
      language: system
      types: [python]
  - repo: local
    hooks:
    - id: isort
      name: isort
      entry: uv run isort
      language: system
      types: [python]
      args: [--profile, black]
  - repo: local
    hooks:
    - id: pylint
      name: pylint
      entry: uv run pylint --rcfile='pyproject.toml'
      language: system
      types: [python]
  - repo: local
    hooks:
    - id: mypy
      name: mypy
      entry: uv run mypy --config-file='pyproject.toml'
      language: system
      types: [python]

EOF
uv run pre-commit install
uv run pre-commit run --all-files

Back to Python Project Setup

Command breakdown

cat <<EOF > .pre-commit-config.yaml
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    ...

EOF

Create the pre-commit config file. We include:

• a range of utility pre-commits to keep your files tidy
• ruff: Initial fast pass linting, think flake8 on steroids
• black: Very opinionated formatter, but keeps your code consistend
• isort: Sort and organise your imports
• pylint: Deep linting based on static code analysis
• mypy: Type checking for your python code

uv run pre-commit install

Install the pre-commit script based on your pre-commit config

uv run pre-commit run --all-files

Run all of the pre-commits across all of the files in the codebase (pre-commits by default only run on your staged files).