Use ruff and a code formatter

[janluke]

black is the obvious choice but I tend to dislike it, especially for CLI code, which tends to take too much vertical space when formatted with black.

The tools should be integrated with tox and github actions.

[kdeldycke]

FWIW, and for inspiration, here is my workflow to auto-format Python code with a mix of isort, pycln, docformatter, autopep8 and black: https://github.com/kdeldycke/workflows/blob/09513de7b01bae8f0c105a37ed72394500e1f7aa/.github/workflows/autofix.yaml#L94-L149

[ulgens]

Hey,

I can handle this one. I have this sample configuration with ruff, pre-commit and Github Actions:

• ruff rules are handled under pyproject.toml, but can be moved to ruff.toml if necessary: https://github.com/ulgens/django-blasphemy/blob/main/pyproject.toml#L63
• Lint & format tools are handled by pre-commit: https://github.com/ulgens/django-blasphemy/blob/main/.pre-commit-config.yaml
• pre-commit is automatically run with Github Actions: https://github.com/ulgens/django-blasphemy/blob/main/.github/workflows/pre-commit.yml

The beauty of this setup is fully automated and requires minimal effort to change rules / settings. I'm planning to adapt that in this repo too, if that sounds okay.

[janluke]

You're very welcome to contribute if you want but keep in mind the following:

• I think pre-commit is redundant with tox: it mostly creates venvs where to run tools; if a developer wants to run linters automatically on each commit, she/he can just call tox in the git hook script; if we want to make that even easier, we can add a Makefile command that does this for the developer (e.g. echo "tox -e lint" >> <hook_path>)
• I'm all for a code formatter, but I've been hesitant on adopting black in this repo, because black makes the typical cloup/click code take a lot of vertical space.