The National Archives Ruff config

These configurations are included in the tna-python-dev Docker image as part of the format command.

Two Ruff configurations are available:

• ruff.toml - a general purpose Ruff configuration
• ruff-strict.toml - a configuration with a stricter set of rules

Standard configuration

The standard configuration ruff.toml includes the following rules:

Ignores

Certain rules are ignored for __init__.py files:

• E402 (module-import-not-at-top-of-file) and PLC0415 (import-outside-top-level) - some imports like in Django settings files are added later on in the file, sometimes under conditionals
• F401 (unused-import) - imports don't have to be used in module files which also helps with Django settings

Strict configuration

Extra rules are included in ruff-strict.toml. You can find more information on each of the rules in the Ruff rules documentation.

Using from PyPI

# Install with Poetry
poetry add tna-ruff-config
TNA_RUFF_CONFIG_DIRECTORY="$(poetry run python -c 'from sysconfig import get_path; print(get_path("platlib"))')/tna_ruff_config"

# ...or pip
pip install tna-ruff-config
TNA_RUFF_CONFIG_DIRECTORY="$(python -c 'from sysconfig import get_path; print(get_path("platlib"))')/tna_ruff_config"

# Run Ruff check using the standard config
ruff check /app --fix --config "$TNA_RUFF_CONFIG_DIRECTORY/ruff.toml"
# Run the Ruff formatter using the standard config
ruff format /app --config "$TNA_RUFF_CONFIG_DIRECTORY/ruff.toml"