chore: replace pylint, isort, black with ruff (DEV-2972)

.github/workflows/tests-on-push.yml

@@ -63,14 +63,15 @@ jobs:
       - name: Install Python dependencies
         run: poetry install
       # run tests
-      - name: Linting with Pylint
-        run: poetry run pylint src test
+      - name: Linting with ruff
+        run: >
+          poetry run ruff check . 
+          --output-format=github 
+          --ignore=A002,A003,B023,D101,D102,D103,PLR0911,PLR0912,PLR0913,PLR0915,PLR2004,PLR5501,PLW0603
+      - name: Formatting with ruff
+        run: poetry run ruff format .
       - name: Linting with mypy
         run: poetry run mypy .
-      - name: Linting with black
-        run: poetry run black --check .
-      - name: Linting with isort
-        run: poetry run isort . --check --diff
       - name: Linting with darglint
         run: poetry exec darglint
 

.pre-commit-config.yaml

@@ -1,14 +1,27 @@
 # Configuration of https://pre-commit.com/
 
 repos:
-  - repo: https://github.com/psf/black-pre-commit-mirror  # faster than https://github.com/psf/black
-    rev: 23.9.1
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.6
     hooks:
-      - id: black
-        # It is recommended to specify the latest version of Python supported by your project here,
-        # or alternatively use pre-commit's default_language_version,
-        # see https://pre-commit.com/#top_level-default_language_version
-        language_version: python3.11
+      - id: ruff
+        args: [
+          --ignore=A002,
+          --ignore=A003,
+          --ignore=B023,
+          --ignore=D101,
+          --ignore=D102,
+          --ignore=D103,
+          --ignore=PLR0911,
+          --ignore=PLR0912,
+          --ignore=PLR0913,
+          --ignore=PLR0915,
+          --ignore=PLR2004,
+          --ignore=PLR5501,
+          --ignore=PLW0603,
+        ]
+      - id: ruff-format
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
@@ -42,8 +55,3 @@ repos:
     hooks:
     - id: markdownlint
       args: [--config, .markdownlint.yml, --ignore, CHANGELOG.md]
-
-  - repo: https://github.com/PyCQA/isort 
-    rev: 5.11.5
-    hooks:
-    - id: isort

README.md

@@ -1,12 +1,11 @@
-[![](https://badge.fury.io/py/dsp-tools.svg)](https://badge.fury.io/py/dsp-tools) 
-[![](https://img.shields.io/pypi/pyversions/dsp-tools.svg)](https://pypi.org/project/dsp-tools/) 
-[![](https://img.shields.io/badge/Python%20code%20style-black-000000.svg)](https://github.com/psf/black) 
-[![](https://img.shields.io/badge/Python%20linting-pylint-darkgreen)](https://github.com/pylint-dev/pylint) 
-[![](https://img.shields.io/badge/Python%20typing-mypy-darkgreen)](https://github.com/python/mypy) 
-[![](https://img.shields.io/badge/Markdown%20linting-markdownlint-darkgreen)](
-  https://github.com/igorshubovych/markdownlint-cli) 
-[![](https://img.shields.io/badge/Link%20validation-markdown%20link%20validator-darkgreen)](
-  https://www.npmjs.com/package/markdown-link-validator)
+[![](https://img.shields.io/pypi/v/dsp-tools.svg)](https://pypi.org/project/dsp-tools/) 
+[![](https://img.shields.io/pypi/l/dsp-tools.svg)](https://pypi.org/project/dsp-tools/) 
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)
+  ](https://github.com/astral-sh/ruff) 
+[![](https://img.shields.io/badge/mypy-blue)](https://github.com/python/mypy) 
+[![](https://img.shields.io/badge/markdownlint-darkgreen)](https://github.com/igorshubovych/markdownlint-cli) 
+[![](https://img.shields.io/badge/markdown%20link%20validator-darkgreen)
+  ](https://www.npmjs.com/package/markdown-link-validator) 
 
 
 # DSP-TOOLS - DaSCH Service Platform Tools
@@ -166,17 +165,15 @@ please make sure you use the same code style rules as we do.
 We use the following linters:
 
 - [MarkdownLint](https://github.com/igorshubovych/markdownlint-cli) (configured in `.markdownlint.yml`)
-- [Black](https://pypi.org/project/black/) (configured in `pyproject.toml`)
 - [mypy](https://pypi.org/project/mypy/) (configured in `pyproject.toml`)
-- [pylint](https://pypi.org/project/pylint/) (configured in `pyproject.toml`)
-- [isort](https://pypi.org/project/isort/) (configured in `pyproject.toml`)
+- [ruff](https://pypi.org/project/ruff/) (configured in `pyproject.toml`)
 - [darglint](https://pypi.org/project/darglint/) (configured in `.darglint`)
 
 These linters are integrated in the GitHub CI pipeline, 
 so that every pull request is checked for code style violations.
 
 In addition, there are [pre-commit hooks](#pre-commit-hooks) 
-that run Black and MarkdownLint locally before every commit.
+that run Ruff and MarkdownLint locally before every commit.
 This prevents you from committing code style violations.
 Pre-commit is contained in the dependencies, 
 but before the first use, the hooks must be installed with `pre-commit install`
@@ -189,17 +186,16 @@ Depending on your IDE the installation is as follows.
 
 - **MarkdownLint** can be installed as an extension (`davidanson.vscode-markdownlint`), 
   and be configured in the VSCode settings.
-- **Black** can be set as formatter in the `ms-python.python` extension.
-  To do so, set `"python.formatting.provider": "black"` in the VSCode `settings.json`.
-  Alternatively, `ms-python.black-formatter` can be installed as an extension.
 - **mypy** can be installed as an extension (`matangover.mypy`), 
   and be configured in the VSCode settings.
     - This extension is different from the mypy functionality 
       of Microsoft's Python extension `ms-python.python`,
       which only lints each file separately, 
       leading to incomplete type checking.
-- **pylint** can be installed as an extension (`ms-python.pylint`), 
-  and be configured in the VSCode settings.
+- **ruff** can be installed as an extension (`charliermarsh.ruff`), 
+  and be configured in the VSCode settings:
+    - `settings.json` > `[python]` > `"editor.defaultFormatter": "charliermarsh.ruff"`
+    - `settings.json` > `"ruff.format.args": ["--line-length=120"]`
 
 If configured correctly, the style violations will be listed in the "Problems" tab.
 

docs/developers/code-quality-tools/code-quality-tools.md

@@ -12,17 +12,13 @@ The decision to use this set of tools is based on the information in the followi
 | --------------------------------------------------------------- | ------------------------------------------------------------------ | ------------------------------ |
 | [General formatting](./general-formatting.md)                   | [EditorConfig](https://EditorConfig.org/)                          | `.editorconfig`                |
 |                                                                 | [MarkdownLint](https://github.com/igorshubovych/markdownlint-cli/) | `.markdownlint.yml`            |
-| [Python formatting](./python-formatting.md)                     | [Black](https://pypi.org/project/black/)                           | `pyproject.toml`               |
-| [Python docstring formatting](./python-docstring-formatting.md) | [pydocstyle](https://pypi.org/project/pydocstyle/) *               |                                |
-|                                                                 | [darglint](https://pypi.org/project/darglint/)                     | `.darglint`                    |
+| [Python formatting](./python-formatting.md)                     | [Ruff](https://pypi.org/project/ruff/)                             | `pyproject.toml`               |
+| [Python docstring formatting](./python-docstring-formatting.md) | [darglint](https://pypi.org/project/darglint/)                     | `.darglint`                    |
 | [Python type checking](./python-type-checking.md)               | [mypy](https://pypi.org/project/mypy/)                             | `pyproject.toml`               |
-| [Python linting](./python-linting.md)                           | [Ruff](https://pypi.org/project/ruff/) *                           |                                |
-|                                                                 | [pylint](https://pypi.org/project/pylint/) **                      | `pyproject.toml`               |
+| [Python linting](./python-linting.md)                           | [Ruff](https://pypi.org/project/ruff/)                             | `pyproject.toml`               |
 | [Security checks](./security.md)                                | [Dependabot](https://docs.github.com/en/code-security/dependabot/) | `.github/dependabot.yml`       |
 |                                                                 | [CodeQL](https://codeql.github.com/)                               | GitHub settings                |
 |                                                                 | [Gitleaks](https://gitleaks.io/) *                                 | `.gitleaks.toml`               |
 |                                                                 | [Bandit](https://pypi.org/project/bandit/)                         | `.github/workflows/bandit.yml` |
 
 (*) coming soon  
-
-(**) will perhaps become redundant, as Ruff matures

docs/developers/code-quality-tools/python-formatting.md

@@ -24,6 +24,11 @@ Black aims for readability and reducing git diffs.
 Black is an easy-to-use tool, with sensible and useful defaults.
 Its style is very elegant.
 
+### [Ruff](https://pypi.org/project/ruff/)
+
+Besides being a linter, Ruff is also an auto-formatter.
+It is designed as a drop-in replacement for Black.
+
 ### [yapf](https://pypi.org/project/yapf/)
 
 Auto-formatter that can be configured to support different styles.

docs/developers/code-quality-tools/python-linting.md

@@ -34,7 +34,8 @@ Unlike Pyflakes, Flake8 can be configured.
 The fastest, most promising and most exciting linter, although still in beta.
 Ruff is a linter with autofix support.
 It has near-parity with Flake8, and they are working on implementing pylint rules as well
-(see [How does Ruff compare to Pylint?](https://beta.ruff.rs/docs/faq/#how-does-ruff-compare-to-pylint)).
+(see [How Does Ruff's Linter Compare to Pylint?](
+    https://docs.astral.sh/ruff/faq/#how-does-ruffs-linter-compare-to-pylint)).
 Ruff can be used to replace 
 
 - Flake8 (wrapper around Pyflakes, pycodestyle, and McCabe) plus dozens of plugins
@@ -48,6 +49,8 @@ Ruff can be used to replace
 - pyupgrade (automated upgrade to newer python syntax)
 - autoflake (automated removal of unused imports or variables)
 
+Additionally, Ruff's formatter can be used to replace Black.
+
 ### [Vulture](https://pypi.org/project/vulture/)
 
 Static code analyzer that finds unused code in Python programs. 

docs/index.md

@@ -1,12 +1,11 @@
-[![](https://badge.fury.io/py/dsp-tools.svg)](https://badge.fury.io/py/dsp-tools) 
-[![](https://img.shields.io/pypi/pyversions/dsp-tools.svg)](https://pypi.org/project/dsp-tools/) 
-[![](https://img.shields.io/badge/Python%20code%20style-black-000000.svg)](https://github.com/psf/black) 
-[![](https://img.shields.io/badge/Python%20linting-pylint-darkgreen)](https://github.com/pylint-dev/pylint) 
-[![](https://img.shields.io/badge/Python%20typing-mypy-darkgreen)](https://github.com/python/mypy) 
-[![](https://img.shields.io/badge/Markdown%20linting-markdownlint-darkgreen)](
-  https://github.com/igorshubovych/markdownlint-cli) 
-[![](https://img.shields.io/badge/Link%20validation-markdown%20link%20validator-darkgreen)](
-  https://www.npmjs.com/package/markdown-link-validator)
+[![](https://img.shields.io/pypi/v/dsp-tools.svg)](https://pypi.org/project/dsp-tools/) 
+[![](https://img.shields.io/pypi/l/dsp-tools.svg)](https://pypi.org/project/dsp-tools/) 
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)
+  ](https://github.com/astral-sh/ruff) 
+[![](https://img.shields.io/badge/mypy-blue)](https://github.com/python/mypy) 
+[![](https://img.shields.io/badge/markdownlint-darkgreen)](https://github.com/igorshubovych/markdownlint-cli) 
+[![](https://img.shields.io/badge/markdown%20link%20validator-darkgreen)
+  ](https://www.npmjs.com/package/markdown-link-validator) 
 
 # DSP-TOOLS Documentation