Installation¶

pydocformatter requires Python 3.11 or newer.

Project dependency¶

Add pydocformatter to a project environment as a development dependency using uv (or manually edit the pyproject.toml):

uv add --dev pydocformatter

Then ideally run it through uv (or otherwise run it in the suitable project .venv):

uv run pydocfmt check

uv tool¶

Install the command as a standalone tool:

uv tool install pydocformatter

pip¶

Install with pip:

python -m pip install pydocformatter

pipx¶

Install with pipx:

pipx install pydocformatter

Git pre-commit¶

Use one published repository hook when pre-commit should manage the pydocformatter environment. Choose pydocfmt-check for read-only validation, or pydocfmt-fix when commits should apply fixes before reporting remaining findings:

repos:
  - repo: https://github.com/pallgeuer/pydocformatter
    rev: v1.0.0
    hooks:
      - id: pydocfmt-check
      # - id: pydocfmt-fix

Update rev when you intentionally adopt a newer pydocformatter release.

Use a local hook instead when the project already installs pydocformatter, for example in a uv-managed development environment. Choose one hook:

repos:
  - repo: local
    hooks:
      - id: pydocfmt-check
        name: pydocfmt (check)
        entry: uv run pydocfmt check --force-exclude
        language: system
        types: [python]
      # - id: pydocfmt-fix
      #   name: pydocfmt (fix)
      #   entry: uv run pydocfmt check --fix --force-exclude
      #   language: system
      #   types: [python]