build: replace isort and flake8 with ruff

.github/workflows/main.yml

@@ -17,9 +17,9 @@ on:
       - "v*"
 
 jobs:
-  # Runs the isort, black & flake8 linting steps inside the specified containers rather than on the VM host.
+  # Runs the ruff & black linting steps inside the specified containers rather than on the VM host.
   # Because of this the network configuration changes from host based network to a container network.
-  linter_isort:
+  linter_ruff:
     runs-on: ubuntu-22.04
     container: python:3.10-slim-bullseye
 
@@ -29,10 +29,10 @@ jobs:
 
       - name: Install Dependencies
         run: |
-          pip install -q isort==5.12.0
-      - name: isort
+          pip install -q ruff==0.0.270
+      - name: ruff
         run: |
-          isort . --check-only --profile black
+          ruff check --format=github .
 
   linter_black:
     runs-on: ubuntu-22.04
@@ -49,21 +49,6 @@ jobs:
         run: |
           black . --check
 
-  linter_flake8:
-    runs-on: ubuntu-22.04
-    container: python:3.10-slim-bullseye
-
-    steps:
-      - name: Checkout Code Repository
-        uses: actions/checkout@v3
-
-      - name: Install Dependencies
-        run: |
-          pip install -q flake8==6.0.0
-      - name: flake8
-        run: |
-          flake8 app/core
-
   # Runs the frontend linting steps on the VM
   linter_stylelint:
     runs-on: ubuntu-22.04
@@ -148,9 +133,8 @@ jobs:
     runs-on: ubuntu-22.04
     needs:
       [
-        linter_isort,
+        linter_ruff,
         linter_black,
-        linter_flake8,
         linter_stylelint,
         linter_eslint,
         linter_prettier,
@@ -248,9 +232,8 @@ jobs:
   release:
     needs:
       [
-        linter_isort,
+        linter_ruff,
         linter_black,
-        linter_flake8,
         linter_stylelint,
         linter_eslint,
         linter_prettier,

.pre-commit-config.yaml

@@ -20,19 +20,15 @@ repos:
         exclude: ^.+\.min\.(js|css)$
       - id: mixed-line-ending
       - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.270
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
   - repo: https://github.com/psf/black
     rev: 23.3.0
     hooks:
       - id: black
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
-    hooks:
-      - id: flake8
-  - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.10.1
-    hooks:
-      - id: isort
-        args: ["--profile", "black"]
   - repo: https://github.com/commitizen-tools/commitizen
     rev: 3.2.2
     hooks:

README.md

@@ -195,7 +195,7 @@ See `pre-commit-config.yaml` for more details. In addition, please note the foll
 ### Dev
 
 - [ ] Switch to [Poetry](https://python-poetry.org/)
-- [ ] Replace [flake8](https://pypi.org/project/flake8/), [pycodestyle](https://pypi.org/project/pydocstyle/) and [isort](https://pypi.org/project/isort/) with [ruff](https://github.com/charliermarsh/ruff)
+- [x] Replace [flake8](https://pypi.org/project/flake8/), [pycodestyle](https://pypi.org/project/pydocstyle/) and [isort](https://pypi.org/project/isort/) with [ruff](https://github.com/charliermarsh/ruff)
 - [ ] Test all the things
 
 ### More ways to listen

pyproject.toml

@@ -41,10 +41,9 @@ dev = [
   "commitizen",
   "coverage[toml]",
   "DSLR",
-  "flake8",
-  "isort",
   "pip-tools",
   "pre-commit",
+  "ruff",
 ]
 
 [tool.setuptools]
@@ -73,13 +72,28 @@ exclude = '''
 )
 '''
 
-[tool.isort]
-profile = "black"
-skip = ["node_modules", ".git", "__pycache__", "LC_MESSAGES", "venv", ".venv"]
-blocked_extensions = ["rst", "html", "js", "svg", "txt", "css", "scss", "png", "snap", "ts", "tsx"]
-known_first_party = "app"
-sections = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"]
-default_section = "THIRDPARTY"
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+select = ["B", "C", "E", "F", "W", "B9"]
+ignore = ["E203", "E266", "E501", "F403", "F401"]
+exclude = [
+  ".git",
+  "__pycache__",
+  "node_modules",
+  "public",
+  "venv",
+]
+
+[tool.ruff.isort]
+known-first-party = ["app"]
+section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]
+
+[tool.ruff.pycodestyle]
+max-doc-length = 120
+
+[tool.ruff.mccabe]
+max-complexity = 10
 
 [tool.coverage.run]
 include = ["app/core/*"]

requirements-dev.txt

@@ -109,8 +109,6 @@ filelock==3.12.0
     # via virtualenv
 filetype==1.2.0
     # via eyed3
-flake8==6.0.0
-    # via zed-news (pyproject.toml)
 frozenlist==1.3.3
     # via
     #   aiohttp
@@ -131,8 +129,6 @@ invoke==2.1.2
     # via zed-news (pyproject.toml)
 iso8601==1.1.0
     # via tortoise-orm
-isort==5.12.0
-    # via zed-news (pyproject.toml)
 jinja2==3.1.2
     # via
     #   commitizen
@@ -153,8 +149,6 @@ marshmallow==3.19.0
     #   marshmallow-enum
 marshmallow-enum==1.5.1
     # via dataclasses-json
-mccabe==0.7.0
-    # via flake8
 multidict==6.0.4
     # via
     #   aiohttp
@@ -206,15 +200,11 @@ psycopg-pool==3.1.7
     # via psycopg
 psycopg2-binary==2.9.6
     # via zed-news (pyproject.toml)
-pycodestyle==2.10.0
-    # via flake8
 pydantic==1.10.8
     # via
     #   aerich
     #   langchain
     #   openapi-schema-pydantic
-pyflakes==3.0.1
-    # via flake8
 pygments==2.15.1
     # via
     #   bpython
@@ -259,6 +249,8 @@ requests-oauthlib==1.3.1
     # via apprise
 rich==12.6.0
     # via dslr
+ruff==0.0.270
+    # via zed-news (pyproject.toml)
 s3transfer==0.6.1
     # via boto3
 sgmllib3k==1.0.0

tasks.py

@@ -121,14 +121,6 @@ def import_db_dump(c, dump_file):
     c.run(f'inv exec "db" "rm -vf /tmp/{dump_file}"', pty=True)
 
 
-@task
-def fix_path(c):
-    """fix the PYTHON_PATH"""
-    # export PYTHONPATH="${PYTHONPATH}":`pwd`
-    cwd = os.path.abspath(__file__)
-    c.run(f'export PYTHONPATH="${{PYTHONPATH}}:{cwd}"', pty=True)
-
-
 @task
 def init_db(c):
     """use aerich to generate schema and generate app migrate location"""
@@ -264,17 +256,16 @@ def execute_bump_hack(c, branch, is_first_release=False, major=False):
         c.run("rm -vf .bump_result.txt", pty=True)
 
 
-@task(help={"fix": "let black and isort format your files"})
+@task(help={"fix": "let black and ruff format your files"})
 def lint(c, fix=False):
-    """flake8, black and isort"""
+    """ruff and black"""
 
     if fix:
         c.run("black .", pty=True)
-        c.run("isort --profile black .", pty=True)
+        c.run("ruff check --fix .", pty=True)
     else:
         c.run("black . --check", pty=True)
-        c.run("isort --check-only --profile black .", pty=True)
-        c.run("flake8 wb", pty=True)
+        c.run("ruff check .", pty=True)
 
 
 # TODO: create a "clean" collection comprising the next two tasks below