A shareable Ruff starting config designed to get as much as possibly from Ruff quickly.
pip install ruff nickineering-ruff-configPip install this package, Ruff, and create a
ruff.toml or another Ruff supported configuration file in your project root.
Inside that file extend this config like so:
extend = "nickineering-ruff-base.toml"
# Override these settings, or add your own here
# For example:
target-version = "py313"
[format]
docstring-code-format = falseYou will also need to create a script to copy the file, since Ruff does not support extending from a package. This is a Poetry script which does that as an example:
[tool.poetry.scripts]
update-ruff-base = "nickineering_ruff_config:update_ruff_base"You could then run it with poetry run update-ruff-base. This would need to be
re-run to install new versions of this package.
Finally, add the output to your .gitignore so you can rely only on the
package.
# Automatically updated configuration file from nickineering-ruff-config
nickineering-ruff-base.tomlIt is also recommended to create a Makefile or other command runner to
document that the update-ruff-base command must be run when installing the
project and so that calls to Ruff run both the lint and format commands. An
example Makefile is below:
setup:
poetry install
poetry run update-ruff-base
lint:
ruff format
ruff check --fixA Github Action is automatically run deploying this code to PyPi when a new release is published in Github.