Use UV and pre-commit.ci in CI suite

Author: codingjoe

.github/workflows/ci.yml

@@ -7,36 +7,16 @@ on:
 
 jobs:
 
-  lint:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        lint-command:
-          - bandit -r . -x ./tests
-          - black --check --diff .
-          - flake8 .
-          - isort --check-only --diff .
-          - pydocstyle .
-    steps:
-      - uses: actions/checkout@v6
-      - uses: actions/setup-python@v6
-        with:
-          python-version: "3.x"
-          cache: 'pip'
-          cache-dependency-path: 'linter-requirements.txt'
-      - run: python -m pip install -r linter-requirements.txt
-      - run: ${{ matrix.lint-command }}
-
   dist:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
-      - uses: actions/setup-python@v6
+      - uses: astral-sh/setup-uv@v7
+      - run: uvx --from build pyproject-build --sdist --wheel
+      - run: uvx twine check dist/*
+      - uses: actions/upload-artifact@v6
         with:
-          python-version: "3.x"
-      - run: python -m pip install --upgrade pip build wheel twine readme-renderer
-      - run: python -m build --sdist --wheel
-      - run: python -m twine check dist/*
+          path: dist/*
 
   standardjs:
     runs-on: ubuntu-latest
@@ -52,16 +32,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
-      - uses: actions/setup-python@v6
-        with:
-          python-version: "3.10"
       - run: sudo apt-get install -y gettext graphviz
-      - run: python -m pip install -e .[docs]
-      - run: python -m sphinx -W -b doctest -b html docs docs/_build
+      - uses: astral-sh/setup-uv@v7
+      - run: uv run sphinx-build -W -b doctest -b html docs docs/_build
 
   PyTest:
     needs:
-      - lint
       - standardjs
     strategy:
       matrix:
@@ -76,33 +52,22 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
-      - uses: actions/setup-python@v6
+      - uses: astral-sh/setup-uv@v7
         with:
           python-version: ${{ matrix.python-version }}
-      - run: python -m pip install Django~="${{ matrix.django-version }}.0"
-      - run: python -m pip install -e .[test]
-      - run: python -m pytest -m "not selenium"
+      - run: uv run --with Django~=${{ matrix.django-version }}.0 pytest -m "not selenium"
       - uses: codecov/codecov-action@v5
 
   Selenium:
     needs:
-      - lint
       - standardjs
-    strategy:
-      matrix:
-        python-version:
-          - "3.x"
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
       - name: Install Selenium
         run: |
           curl -LsSfO https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
           sudo dpkg -i google-chrome-stable_current_amd64.deb || sudo apt-get -f install -y
-      - uses: actions/setup-python@v6
-        with:
-          python-version: ${{ matrix.python-version }}
-      - run: python -m pip install Django
-      - run: python -m pip install -e .[test,selenium]
-      - run: python -m pytest -m selenium
+      - uses: astral-sh/setup-uv@v7
+      - run: uv run pytest -m selenium
       - uses: codecov/codecov-action@v5

.gitignore

@@ -25,3 +25,6 @@ coverage.xml
 db.sqlite3
 
 _version.py
+
+# uv
+uv.lock

.pre-commit-config.yaml

@@ -0,0 +1,45 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: check-ast
+      - id: check-toml
+      - id: check-yaml
+      - id: check-symlinks
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: no-commit-to-branch
+        args: [--branch, main]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.21.2
+    hooks:
+      - id: pyupgrade
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: 1.29.1
+    hooks:
+      - id: django-upgrade
+  - repo: https://github.com/hukkin/mdformat
+    rev: 1.0.0
+    hooks:
+      - id: mdformat
+        additional_dependencies:
+          - mdformat-ruff
+          - mdformat-footnote
+          - mdformat-gfm
+          - mdformat-gfm-alerts
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.9
+    hooks:
+      - id: ruff-check
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+  - repo: https://github.com/google/yamlfmt
+    rev: v0.20.0
+    hooks:
+      - id: yamlfmt
+ci:
+  autoupdate_schedule: weekly
+  skip:
+    - no-commit-to-branch

CONTRIBUTING.rst

@@ -9,19 +9,13 @@ you have binary dependencies installed::
     # macOS
     brew install -y gettext graphviz google-chrome-stable
 
-To install the package and its dependencies for development
-including tests dependencies, please do:
-
-    python -m pip install -e .[test]
-
 You may ran the tests via::
 
-    python -m pytest
+    uv run pytest
 
 Documentation pull requests welcome. The Sphinx documentation can be compiled via::
 
-    python -m pip install -e .[docs]
-    python -m sphinx -W -b doctest -b html docs docs/_build
+    uv run sphinx-build -b html docs docs/_build/html
 
 Bug reports welcome, even more so if they include a correct patch.  Much
 more so if you start your patch by adding a failing unit test, and correct

pyproject.toml

@@ -35,16 +35,17 @@ dependencies = [
   "django-appconf>=0.6.0"
 ]
 
-[project.optional-dependencies]
+[dependency-groups]
+dev = [
+  { include-group = "test" },
+  { include-group = "docs" },
+]
 test = [
   "pytest",
   "pytest-cov",
   "pytest-django",
   "selenium",
 ]
-selenium = [
-  "selenium",
-]
 docs = [
   "sphinx",
 ]