Replace black
with ruff
and add pre-commit
#110
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey @tom-andersson et al - just a maintenance-related PR for your perusal, feel free to reject if this isn't your thing.
What this PR does
black
withruff
as the linter of choice, partially because of extra features such as linting docstrings in google-style (which black may do as well, but I haven't been able to find it)pre-commit
and a pre-commit config to run the ruff linter and formatter on a pre-commit hook.CONTRIBUTING.md
detailing the use of these tools.What this PR doesn't do
At the moment the CI check fails since
ruff
is checking all the docstrings, we may be able to soften the docstring rules (configured inpyproject.toml
) to something we agree with (e.g. I don't necessarily think that every module needs a docstring)FYI @nilsleh