Replace Black, isort and flake8 with Ruff

.github/workflows/tests.yml

@@ -24,15 +24,8 @@ jobs:
           poetry run pip install --upgrade pip
           poetry run pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu
           poetry run pip install lightning
-      - uses: isort/isort-action@master
-        with:
-          sort-paths: "./shimmer"
-      - uses: psf/black@stable
-        with:
-          src: "./shimmer"
-      - name: Analysing the code with flake8
-        run: |
-          poetry run flake8 .
+      - name: Ruff checks
+        uses: chartboost/ruff-action@v1
       - name: Analysing the code with mypy
         run: |
           poetry run mypy --install-types --non-interactive .

.gitignore

@@ -158,4 +158,7 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+.ruff_cache/
+
 docs/api/

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.3.0
+      hooks:
+        # Run the linter.
+        - id: ruff
+          args: [ --fix ]
+        # Run the formatter.
+        - id: ruff-format

CONTRIBUTING.md

@@ -14,8 +14,8 @@ With each commit, the github workflow is executed and will check for:
 
 ## Code quality workflow
 This workflow makes sure that the provided code follows correct code formatting
-(using [isort](https://github.com/PyCQA/isort) and [black](https://github.com/psf/black)),
-[flake8](https://github.com/PyCQA/flake8), and type issues with [mypy](https://github.com/python/mypy).
+and linting using [ruff](https://github.com/astral-sh/ruff),
+and type issues with [mypy](https://github.com/python/mypy).
 
 This project is fully typed, so any contribution should provide typing annotations.
 
@@ -26,16 +26,19 @@ poetry install --with=dev
 
 Then you can run:
 ```sh
-poetry run isort .
+poetry run ruff check . --fix  # lint the project (and fix errors if ruff can)
 ```
 ```sh
-poetry run black .
-```
-```sh
-poetry run flake8 .
+poetry run ruff format .  # reformat the project
 ```
+
+> [!NOTE]
+> There is a [pre-commit](https://pre-commit.com/) configuration set to lint and
+> reformat usinf ruff. Set it up to everything with each commit.
+
+To check type issues with mypy:
 ```sh
-poetry run mypy .
+poetry run mypy --install-types .
 ```
 
 ## Tests