ci!: Add ruff, replacing isort, black, flake8 and its plugins

See also:
- https://ruff.rs/
- https://beta.ruff.rs/
- https://github.com/charliermarsh/ruff

Author: tony

.github/workflows/tests.yml

@@ -23,15 +23,15 @@ jobs:
           cache: 'poetry'
 
       - name: Install dependencies
-        run: poetry install -E "docs test coverage lint format"
+        run: poetry install -E "docs test coverage lint"
 
       - name: Print python versions
         run: |
           python -V
           poetry run python -V
 
-      - name: Lint with flake8
-        run: poetry run flake8
+      - name: Lint with ruff
+        run: poetry run ruff .
 
       - name: Lint with mypy
         run: poetry run mypy .

Makefile

@@ -11,12 +11,6 @@ entr_warn:
 	@echo "See https://eradman.com/entrproject/                      "
 	@echo "----------------------------------------------------------"
 
-isort:
-	poetry run isort `${PY_FILES}`
-
-black:
-	poetry run black `${PY_FILES}`
-
 test:
 	poetry run py.test $(test)
 
@@ -35,11 +29,11 @@ start_docs:
 design_docs:
 	$(MAKE) -C docs design
 
-flake8:
-	flake8 vcspull tests
+ruff:
+	ruff .
 
-watch_flake8:
-	if command -v entr > /dev/null; then ${PY_FILES} | entr -c $(MAKE) flake8; else $(MAKE) flake8 entr_warn; fi
+watch_ruff:
+	if command -v entr > /dev/null; then ${PY_FILES} | entr -c $(MAKE) ruff; else $(MAKE) ruff entr_warn; fi
 
 mypy:
 	poetry run mypy `${PY_FILES}`

docs/developing.md

@@ -22,7 +22,7 @@ $ cd vcspull
 Install packages:
 
 ```console
-$ poetry install -E "docs test coverage lint format"
+$ poetry install -E "docs test coverage lint"
 ```
 
 [installation documentation]: https://python-poetry.org/docs/#installation
@@ -163,56 +163,56 @@ $ make serve
 
 ## Linting
 
-[flake8] and [mypy] run via CI in our GitHub Actions. See the configuration in `pyproject.toml` and
-`setup.cfg`.
+### ruff
 
-### flake8
-
-[flake8] provides fast, reliable, barebones styling and linting.
+The project uses [ruff] to handles formatting, sorting imports and linting.
 
 ````{tab} Command
 
 poetry:
 
 ```console
-$ poetry run flake8
+$ poetry run ruff
 ```
 
 If you setup manually:
 
 ```console
-$ flake8
+$ ruff .
 ```
 
 ````
 
 ````{tab} make
 
 ```console
-$ make flake8
+$ make ruff
 ```
 
 ````
 
 ````{tab} Watch
 
 ```console
-$ make watch_flake8
+$ make watch_ruff
 ```
 
 requires [`entr(1)`].
 
 ````
 
-````{tab} Configuration
+````{tab} Fix files
+
+poetry:
 
-See `[flake8]` in setup.cfg.
+```console
+$ poetry run ruff . --fix
+```
 
-```{literalinclude} ../setup.cfg
-:language: ini
-:start-at: "[flake8]"
-:end-before: "[isort]"
+If you setup manually:
 
+```console
+$ ruff . --fix
 ```
 
 ````
@@ -269,7 +269,7 @@ See `[tool.mypy]` in pyproject.toml.
 
 ## Publishing to PyPI
 
-As of 0.10, [poetry] handles virtualenv creation, package requirements, versioning,
+[poetry] handles virtualenv creation, package requirements, versioning,
 building, and publishing. Therefore there is no setup.py or requirements files.
 
 Update `__version__` in `__about__.py` and `pyproject.toml`::
@@ -284,7 +284,5 @@ Update `__version__` in `__about__.py` and `pyproject.toml`::
 [poetry]: https://python-poetry.org/
 [entr(1)]: http://eradman.com/entrproject/
 [`entr(1)`]: http://eradman.com/entrproject/
-[black]: https://github.com/psf/black
-[isort]: https://pypi.org/project/isort/
-[flake8]: https://flake8.pycqa.org/
+[ruff]: https://ruff.rs
 [mypy]: http://mypy-lang.org/