Transition tooling to hatch

.github/workflows/publish-develop-docs.yml

@@ -14,12 +14,14 @@ jobs:
             - uses: actions/setup-python@v5
               with:
                   python-version: 3.x
-            - run: pip install -r requirements/build-docs.txt
+                  cache: pip
+            - name: Install dependecies
+              run: |
+                  pip install --upgrade hatch uv
             - name: Publish Develop Docs
               run: |
                   git config user.name github-actions
                   git config user.email [email protected]
-                  cd docs
-                  mike deploy --push develop
+                  hatch run docs:develop
         concurrency:
             group: publish-docs

.github/workflows/publish-py.yml

@@ -16,14 +16,17 @@ jobs:
               uses: actions/setup-python@v5
               with:
                   python-version: "3.x"
-            - name: Install dependencies
+                  cache: pip
+            - name: Install dependecies
               run: |
-                  python -m pip install --upgrade pip 
-                  pip install -r requirements/build-src.txt
-            - name: Build and publish
+                  pip install --upgrade hatch uv
+            - name: Build
+              run: |
+                  hatch build --clean
+            # TODO: Update trusted publishing with pypa/gh-action-pypi-publish
+            - name: Publish
               env:
                   TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
                   TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
               run: |
-                  python -m build --sdist --wheel --outdir dist .
                   twine upload dist/*

.github/workflows/publish-release-docs.yml

@@ -14,12 +14,14 @@ jobs:
             - uses: actions/setup-python@v5
               with:
                   python-version: 3.x
-            - run: pip install -r requirements/build-docs.txt
+                  cache: pip
+            - name: Install dependecies
+              run: |
+                  pip install --upgrade hatch uv
             - name: Publish ${{ github.event.release.name }} Docs
               run: |
                   git config user.name github-actions
                   git config user.email [email protected]
-                  cd docs
-                  mike deploy --push --update-aliases ${{ github.event.release.name }} latest
+                  hatch run docs:deploy ${{ github.event.release.name }}
         concurrency:
             group: publish-docs

.github/workflows/test-docs.yml

@@ -1,4 +1,4 @@
-name: Test
+name: Test Docs
 
 on:
     pull_request:
@@ -17,11 +17,13 @@ jobs:
             - uses: actions/setup-python@v5
               with:
                   python-version: 3.x
+                  cache: pip
+            - name: Install dependecies
+              run: |
+                  pip install --upgrade hatch uv
+            - name: Check documentation links
+              run: |
+                  hatch run docs:linkcheck
             - name: Check docs build
               run: |
-                  pip install -r requirements/build-docs.txt
-                  linkcheckMarkdown docs/ -v -r
-                  linkcheckMarkdown README.md -v -r
-                  linkcheckMarkdown CHANGELOG.md -v -r
-                  cd docs
-                  mkdocs build --strict
+                  hatch run docs:build

.github/workflows/test-src.yml

@@ -1,4 +1,4 @@
-name: Test
+name: Test Code
 
 on:
     push:
@@ -36,22 +36,26 @@ jobs:
                   python-version: ${{ matrix.python-version }}
                   allow-prereleases: true
                   cache: pip
-                  cache-dependency-path: "requirements/*.txt"
 
             - name: Install dependencies
               run: |
-                  python -m pip install --upgrade pip setuptools wheel
-                  python -m pip install --upgrade 'tox>=4.0.0rc3'
+                  python -m pip install --upgrade pip hatch uv
 
-            - name: Run tox targets for ${{ matrix.python-version }}
-              run: tox run -f py$(echo ${{ matrix.python-version }} | tr -d .)
+            - name: Show environment
+              run: |
+                   hatch test --show --python ${{ matrix.python-version }}
+
+            - name: Run tests
+              run: |
+                   hatch test --cover --python ${{ matrix.python-version }}
+                   mv .coverage ".coverage.py${{ matrix.python-version }}"
 
             - name: Upload coverage data
               if: matrix.os != 'windows-latest'
-              uses: actions/upload-artifact@v3
+              uses: actions/upload-artifact@v4
               with:
-                  name: coverage-data
-                  path: ".coverage.*"
+                  name: "coverage-data-py${{ matrix.python-version }}"
+                  path: ".coverage.py${{ matrix.python-version }}"
                   if-no-files-found: error
                   include-hidden-files: true
 
@@ -65,24 +69,25 @@ jobs:
             - uses: actions/setup-python@v5
               with:
                   python-version: "3.11"
+                  cache: pip
 
             - name: Install dependencies
               run: python -m pip install --upgrade coverage[toml]
 
             - name: Download data
-              uses: actions/download-artifact@v3
+              uses: actions/download-artifact@v4
               with:
-                  name: coverage-data
+                  merge-multiple: true
 
-            - name: Combine coverage and fail if it's <100%
+            - name: Combine coverage and fail if it's <95%
               run: |
                   python -m coverage combine
                   python -m coverage html --skip-covered --skip-empty
                   python -m coverage report --fail-under=95
 
             - name: Upload HTML report
               if: ${{ failure() }}
-              uses: actions/upload-artifact@v3
+              uses: actions/upload-artifact@v4
               with:
                   name: html-report
                   path: htmlcov

.gitignore

@@ -73,6 +73,9 @@ coverage.xml
 *.cover
 .hypothesis/
 
+# Linter cache
+.ruff_cache/
+
 # Jupyter Notebook
 .ipynb_checkpoints
 

.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 default_language_version:
-    python: python3.12
+    python: python3.10
 
 repos:
     - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -17,10 +17,6 @@ repos:
       rev: 1.8.0
       hooks:
           - id: pyproject-fmt
-    - repo: https://github.com/tox-dev/tox-ini-fmt
-      rev: 1.3.1
-      hooks:
-          - id: tox-ini-fmt
     - repo: https://github.com/rstcheck/rstcheck
       rev: v6.2.0
       hooks:

pyproject.toml

@@ -1,15 +1,202 @@
 [build-system]
-build-backend = "setuptools.build_meta"
-requires = ["setuptools"]
+build-backend = "hatchling.build"
+requires = [
+  "hatchling",
+]
+
+[project]
+name = "servestatic"
+description = "Production-grade static file server for Python web apps."
+readme = "README.md"
+keywords = [
+  "Django",
+]
+license = "MIT"
+authors = [
+  { name = "Mark Bakhit" },
+]
+requires-python = ">=3.9"
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Framework :: Django",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Communications :: File Sharing",
+  "Topic :: Internet :: WWW/HTTP",
+  "Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware",
+]
+dynamic = [
+  "version",
+]
+dependencies = [
+  "django",
+]
+optional-dependencies.brotli = [
+  "brotli",
+]
+urls.Changelog = "https://archmonger.github.io/ServeStatic/latest/changelog/"
+urls.Documentation = "https://archmonger.github.io/ServeStatic/"
+urls.Homepage = "https://github.com/Archmonger/ServeStatic"
+
+[tool.hatch.version]
+path = "src/servestatic/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "/src",
+  "/tests",
+]
+
+[tool.hatch.build.targets.wheel]
+nclude = [
+  "/src",
+  "/tests",
+]
+
+[tool.hatch.metadata]
+license-files = { paths = [ "LICENSE" ] }
+
+[tool.hatch.envs.default]
+installer = "uv"
+
+#
+# Testing
+#
+[tool.hatch.envs.hatch-test]
+extra-dependencies = [
+  "pytest-sugar",
+  "requests",
+  "brotli",
+]
+randomize = true
+matrix-name-format = "{variable}-{value}"
+
+# Django 3.2 LTS
+[[tool.hatch.envs.hatch-test.matrix]]
+python = [ "3.8", "3.9", "3.10"]
+django = [ "3.2" ]
+
+# Django 4.0
+[[tool.hatch.envs.hatch-test.matrix]]
+python = [ "3.8", "3.9", "3.10" ]
+django = [ "4.0" ]
+
+# Django 4.1
+[[tool.hatch.envs.hatch-test.matrix]]
+python = [ "3.8", "3.9", "3.10", "3.11"]
+django = [ "4.1" ]
+
+# Django 4.2
+[[tool.hatch.envs.hatch-test.matrix]]
+python = [ "3.8", "3.9", "3.10", "3.11", "3.12"]
+django = [ "4.2" ]
+
+# Django 5.0
+[[tool.hatch.envs.hatch-test.matrix]]
+python = [ "3.10", "3.11", "3.12"]
+django = [ "5.0" ]
+
+# Django 5.1
+[[tool.hatch.envs.hatch-test.matrix]]
+python = [ "3.10", "3.11", "3.12"]
+django = [ "5.1" ]
+
+[tool.hatch.envs.hatch-test.overrides]
+matrix.django.dependencies = [
+  { if = [ "3.2" ], value = "Django~=3.2" },
+  { if = [ "4.0" ], value = "Django~=4.0" },
+  { if = [ "4.1" ], value = "Django~=4.1" },
+  { if = [ "4.2" ], value = "Django~=4.2" },
+  { if = [ "5.0" ], value = "Django~=5.0" },
+  { if = [ "5.1" ], value = "Django~=5.1" },
+]
+
+#
+# Documentation
+#
+[tool.hatch.envs.docs]
+template = "docs"
+detached = true
+dependencies = [
+  "mkdocs",
+  "mkdocs-git-revision-date-localized-plugin",
+  "mkdocs-material",
+  "mkdocs-include-markdown-plugin",
+  "linkcheckmd",
+  "mkdocs-spellcheck[all]",
+  "mkdocs-git-authors-plugin",
+  "mkdocs-minify-plugin",
+  "mike",
+]
+
+[tool.hatch.envs.docs.scripts]
+linkcheck = [
+  "linkcheckMarkdown docs/ -v -r",
+  "linkcheckMarkdown README.md -v -r",
+  "linkcheckMarkdown CHANGELOG.md -v -r",
+]
+build = [ "cd docs && mkdocs build --strict" ]
+deploy = [
+  "cd docs && mike deploy --push --update-aliases {args} latest",
+]
+develop = [
+  "cd docs && mike deploy --push develop",
+]
+
+#
+# Linting
+#
+[tool.hatch.envs.lint]
+template = "lint"
+detached = true
+dependencies = [
+  "isort",
+  "flake8",
+  "flake8-bugbear",
+  "flake8-comprehensions",
+  "flake8-logging",
+  "flake8-tidy-imports"
+]
+
+[tool.hatch.envs.lint.scripts]
+check = [
+  "flake8 .",
+]
+
+#
+# Tools
+#
 
 [tool.black]
-target-version = ['py39']
+target-version = [ 'py39' ]
 
 [tool.pytest.ini_options]
 addopts = """\
     --strict-config
     --strict-markers
     """
 
+[tool.coverage.run]
+branch = true
+parallel = true
+source = [
+  "src/",
+  "tests/",
+]
+
+[tool.coverage.paths]
+source = [
+  "src/",
+]
+
+[tool.coverage.report]
+show_missing = true
+
 [tool.rstcheck]
 report_level = "ERROR"