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 configurationruff-strict.toml- a configuration with a stricter set of rules
Standard configuration
The standard configuration ruff.toml includes the following rules:
| Rule | Purpose | Defined by |
|---|---|---|
E4, E7, E9 |
Subset of pycodestyle errors | Ruff default configuration |
F |
Pyflakes | Ruff default configuration |
W |
pycodestyle warnings | ruff.toml |
C901 |
mccabe "Function is too complex" | ruff.toml |
B |
flake8-bugbear | ruff.toml |
I |
isort | ruff.toml |
Ignores
Certain rules are ignored for __init__.py files:
E402(module-import-not-at-top-of-file) andPLC0415(import-outside-top-level) - some imports like in Django settings files are added later on in the file, sometimes under conditionalsF401(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"
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tna_ruff_config-0.2.0.tar.gz.
File metadata
- Download URL: tna_ruff_config-0.2.0.tar.gz
- Upload date:
- Size: 3.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1a1f666974fdead2d0e2f5108937ad2f07f97af0b7b04f5f5a90e09dc6f2f909
|
|
| MD5 |
ada77cc2a52053d5b57dd398deb5be50
|
|
| BLAKE2b-256 |
c6f9abc31a3458edfc55c87ca9b3ebcfdcb7d9fdc1cf7d19b8c8e87e9bfde8c1
|
Provenance
The following attestation bundles were made for tna_ruff_config-0.2.0.tar.gz:
Publisher:
publish.yml on nationalarchives/ruff-config
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tna_ruff_config-0.2.0.tar.gz -
Subject digest:
1a1f666974fdead2d0e2f5108937ad2f07f97af0b7b04f5f5a90e09dc6f2f909 - Sigstore transparency entry: 2281125470
- Sigstore integration time:
-
Permalink:
nationalarchives/ruff-config@e6f960701728b1d27fcba24d6bd94989626729aa -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/nationalarchives
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@e6f960701728b1d27fcba24d6bd94989626729aa -
Trigger Event:
release
-
Statement type:
File details
Details for the file tna_ruff_config-0.2.0-py3-none-any.whl.
File metadata
- Download URL: tna_ruff_config-0.2.0-py3-none-any.whl
- Upload date:
- Size: 4.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
02ae87ab9d78385aeb8a7fc1792fd4e845d8cc068a6f8c9fc036c7f4b59e455f
|
|
| MD5 |
72d9007fa1892a0e5163748761ce549b
|
|
| BLAKE2b-256 |
bcb5dad54ea3414dcf8ef0a6fdf0e229bdd9bf58dd1a084a8fc4a1ac92bca3bf
|
Provenance
The following attestation bundles were made for tna_ruff_config-0.2.0-py3-none-any.whl:
Publisher:
publish.yml on nationalarchives/ruff-config
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tna_ruff_config-0.2.0-py3-none-any.whl -
Subject digest:
02ae87ab9d78385aeb8a7fc1792fd4e845d8cc068a6f8c9fc036c7f4b59e455f - Sigstore transparency entry: 2281125479
- Sigstore integration time:
-
Permalink:
nationalarchives/ruff-config@e6f960701728b1d27fcba24d6bd94989626729aa -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/nationalarchives
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@e6f960701728b1d27fcba24d6bd94989626729aa -
Trigger Event:
release
-
Statement type:
