Switch to pyproject.toml, ruff, and update build tooling (#73)

* Remove black, flake8, isort
* Switch to ruff
* Switch from setup.py to pyproject.toml
* Update azure pipeline to Python 3.12 and PublishCodeCoverageResults@2

Author: vsalvino

azure-pipelines.yml

@@ -71,11 +71,10 @@ stages:
         testResultsFiles: '**/test-*.xml'
         testRunTitle: 'Publish test results for Python $(python.version)'
 
-    - task: PublishCodeCoverageResults@1
+    - task: PublishCodeCoverageResults@2
       displayName: 'Publish code coverage report'
       condition: succeededOrFailed()
       inputs:
-        codeCoverageTool: Cobertura
         summaryFileLocation: '$(System.DefaultWorkingDirectory)/coverage.xml'
 
 
@@ -93,7 +92,7 @@ stages:
     - task: UsePythonVersion@0
       displayName: 'Use Python version'
       inputs:
-        versionSpec: '3.11'
+        versionSpec: '3.12'
         architecture: 'x64'
 
     - script: python -m pip install -r requirements-dev.txt
@@ -102,14 +101,11 @@ stages:
     - script: codespell ./docs/ ./wagtailcache/
       displayName: 'CR-QC: Spell check'
 
-    - script: flake8 .
-      displayName: 'CR-QC: Static analysis (flake8)'
+    - script: ruff check .
+      displayName: 'CR-QC: Static analysis (ruff)'
 
-    - script: isort --check .
-      displayName: 'CR-QC: Format check (isort)'
-
-    - script: black --check .
-      displayName: 'CR-QC: Format check (black)'
+    - script: ruff format --check .
+      displayName: 'CR-QC: Format check'
 
     - script: mypy ./wagtailcache/
       displayName: 'CR-QC: Type check (mypy)'
@@ -144,7 +140,7 @@ stages:
     - task: UsePythonVersion@0
       displayName: 'Use Python version'
       inputs:
-        versionSpec: '3.11'
+        versionSpec: '3.12'
         architecture: 'x64'
 
     - script: python -m pip install -r requirements-dev.txt

ci/compare-codecov.ps1

@@ -68,7 +68,8 @@ foreach ($cov in $mainCoverageJson.coverageData.coverageStats) {
 
 
 # Get current code coverage from coverage.xml file.
-$coveragePath = Get-ChildItem -Recurse -Filter "coverage.xml" $wd
+# Use the first one, if there are multiple i.e. from multiple runs.
+$coveragePath = (Get-ChildItem -Recurse -Filter "coverage.xml" $wd)[0]
 if (Test-Path -Path $coveragePath) {
     [xml]$BranchXML = Get-Content $coveragePath
 }
@@ -84,7 +85,7 @@ $branchlinerate = [math]::Round([decimal]$BranchXML.coverage.'line-rate' * 100,
 
 
 Write-Output ""
-Write-Output "Dev branch coverage rate:   $mainlinerate%"
+Write-Output "Main branch coverage rate:  $mainlinerate%"
 Write-Output "This branch coverage rate:  $branchlinerate%"
 
 if ($mainlinerate -eq 0) {

docs/contributing.rst

@@ -58,4 +58,4 @@ the ``dist/`` directory.
 
 .. code-block:: console
 
-    $ python setup.py sdist bdist_wheel
+    $ python -m build

pyproject.toml

@@ -1,25 +1,79 @@
-[tool.black]
+# -- PACKAGE INFO ---------------------
+
+[build-system]
+requires = ["setuptools >= 65.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+authors = [
+    {name = "CodeRed LLC", email = "[email protected]"}
+]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Framework :: Django",
+    "Framework :: Wagtail",
+    "Framework :: Wagtail :: 3",
+    "Framework :: Wagtail :: 4",
+    "Framework :: Wagtail :: 5",
+    "Framework :: Wagtail :: 6",
+]
+dependencies = [
+    "wagtail>=3.0,<7",
+]
+description = "A simple page cache for Wagtail based on the Django cache middleware."
+dynamic = ["version"]
+license = {file = "LICENSE"}
+name = "wagtail-cache"
+readme = "README.md"
+requires-python = ">=3.8"
+
+[project.urls]
+Source = "https://github.com/coderedcorp/wagtail-cache"
+
+[tool.setuptools]
+packages = ["wagtailcache"]
+
+[tool.setuptools.dynamic]
+version = {attr = "wagtailcache.__version__"}
+
+
+# -- TOOLS ----------------------------
+
+[tool.codespell]
+ignore-words-list = ["doubleclick"]
+
+[tool.django-stubs]
+django_settings_module = "testproject.settings"
+
+[tool.mypy]
+ignore_missing_imports = true
+check_untyped_defs = true
+exclude = [
+    '^\..*',
+    'migrations',
+    'node_modules',
+    'venv',
+]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "testproject.settings"
+junit_family = "xunit2"
+addopts = "--cov wagtailcache --cov-report html --cov-report xml --junitxml junit/test-results.xml"
+python_files = "tests.py test_*.py"
+
+[tool.ruff]
+extend-exclude = ["build", "migrations"]
 line-length = 80
-target-version = ['py38', 'py39', 'py310', 'py311']
-# Regular expression of files to exclude.
-exclude = '''
-/(
-    \.venv
-    | build
-    | migrations
-)/
-'''
-
-[tool.isort]
-force_alphabetical_sort_within_sections = true
-force_single_line = true
-lines_after_imports = 2
-lines_before_imports = 0
-lines_between_sections = 1
-lines_between_types = 0
-line_length = 80
-profile = "black"
-skip_gitignore = true
-extend_skip = ["migrations"]
-# Specific to this project
-known_first_party = ["home", "wagtailcache"]
+
+[tool.ruff.lint]
+extend-select = ["I"]
+
+[tool.ruff.lint.isort]
+case-sensitive = false
+force-single-line = true
+lines-after-imports = 2

requirements-dev.txt

@@ -1,13 +1,12 @@
 -e ./
-black
+build
 codespell
-flake8
-isort
 mypy
 pytest
 pytest-cov
 pytest-django
+ruff
+setuptools>=65.0
 sphinx
 sphinx-wagtail-theme
 twine
-wheel

setup.cfg

@@ -3,9 +3,9 @@
 from django.contrib.auth.models import User
 from django.contrib.contenttypes.models import ContentType
 from django.core.cache import caches
+from django.test import TestCase
 from django.test import modify_settings
 from django.test import override_settings
-from django.test import TestCase
 from django.urls import reverse
 from wagtail import hooks
 from wagtail.models import PageViewRestriction
@@ -17,8 +17,8 @@
 from home.models import CsrfPage
 from home.models import WagtailPage
 from wagtailcache.cache import CacheControl
-from wagtailcache.cache import clear_cache
 from wagtailcache.cache import Status
+from wagtailcache.cache import clear_cache
 from wagtailcache.settings import wagtailcache_settings
 
 

setup.py

@@ -2,12 +2,11 @@
 from django.contrib import admin
 from django.urls import include
 from django.urls import path
+from home import views
 from wagtail import urls as wagtail_urls
 from wagtail.admin import urls as wagtailadmin_urls
 from wagtail.documents import urls as wagtaildocs_urls
 
-from home import views
-
 
 urlpatterns = [
     path("django-admin/", admin.site.urls),