Enforce consistent formatting using ruff

- replaces flake8 checks with ruff
- ruff linting for consistent import sorting
- consistent ruff auto-formatting in vscode config (including import sorting)
- gh-action: linting and formatting checks using ruff in a separate jobs (for faster feedback)

Author: stefanfoulis

.github/workflows/main.yml

@@ -7,10 +7,28 @@ on:
     branches: ["develop"]
 
 jobs:
+  formatting:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+        with:
+          args: "--version"
+      - run: "ruff format --check --diff"
+  
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+        with:
+          args: "--version"
+      - run: "ruff check --diff"
+
   tests:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
       with:
         python-version: |
@@ -25,4 +43,6 @@ jobs:
         python -m pip install --upgrade pip
         pip install tox
     - name: Run tox
-      run: tox
+      # we skip the 'ruff' env here, because we are running it in a separate 
+      # parallel job already
+      run: tox --skip-env ruff

.vscode/settings.json

@@ -2,8 +2,8 @@
     "[python]": {
         "editor.formatOnSave": true,
         "editor.codeActionsOnSave": {
-            "source.fixAll": "explicit",
-            "source.organizeImports": "explicit"
+            "source.fixAll.ruff": "explicit",
+            "source.organizeImports.ruff": "explicit"
         },
         "editor.defaultFormatter": "charliermarsh.ruff"
     }

pyproject.toml

@@ -1,5 +1,13 @@
 [tool.ruff]
 line-length = 100
 
+[tool.ruff.lint]
+select = [
+    # Pyflakes
+    "F",
+    # isort
+    "I",
+]
+
 [tool.ruff.lint.isort]
 force-single-line = true

tox.ini

@@ -7,7 +7,7 @@ envlist=
     py311-django{41,42,50,51},
     py312-django{41,42,50,51},
     py313-django{41,42,50,51},
-    flake8
+    ruff
 
 [testenv]
 changedir=
@@ -23,7 +23,6 @@ deps =
     psycopg2-binary
     pytest
     pytest-django
-    pytest-flake8
     pytest-cov
 
 commands =
@@ -41,12 +40,13 @@ commands =
     mkdir -p _static/
     sphinx-build -v -W -b html -d {envtmpdir}/doctrees -D html_static_path="_static" . {envtmpdir}/html
 
-[testenv:flake8]
+[testenv:ruff]
 basepython = python3.11
 deps =
-    flake8
+    ruff
 commands =
-    flake8 . --exclude=venv/,.tox/,migrations --max-line-length 100
+    ruff check --diff
+    ruff format --check --diff
 
 [pytest]
 DJANGO_SETTINGS_MODULE = oidc_provider.tests.settings