Code Style

Formatting and linting

vcspull uses ruff for formatting and linting.

$ uv run ruff format .
$ uv run ruff check . --fix --show-fixes

Type checking

mypy runs in strict mode.

$ uv run mypy

Docstrings

Follow NumPy docstring convention.

Imports

  • Use from __future__ import annotations in every file.

  • Prefer namespace imports for stdlib: import pathlib not from pathlib import Path.

  • Use import typing as t and access via t.NamedTuple, t.TYPE_CHECKING, etc.