bump template to v2024.27 and add support for Django 5.1 (#111)

westerveltco · Sep 11, 2024 · ac65284 · ac65284
1 parent fa53eb1
commit ac65284
Show file tree

Hide file tree

Showing 15 changed files with 65 additions and 16 deletions.
diff --git a/.copier/package.yml b/.copier/package.yml
@@ -1,12 +1,13 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: v2024.24
+_commit: v2024.27
 _src_path: gh:westerveltco/django-twc-package
 author_email: josh@joshthomas.dev
 author_name: Josh Thomas
 current_version: 0.15.0
 django_versions:
 - '4.2'
 - '5.0'
+- '5.1'
 docs_domain: westervelt.dev
 github_owner: westerveltco
 github_repo: django-twc-toolbox

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1 +1,2 @@
 *       @westerveltco/oss
+/docs/  @westerveltco/web-dev-docs
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -24,7 +24,8 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.12
+          python-version: "3.13"
+          allow-prereleases: true
 
       - name: Install dependencies
         run: |

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -25,6 +25,7 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: "3.10"
+          allow-prereleases: true
 
       - name: Install dependencies
         run: |
@@ -47,7 +48,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: "${{ matrix.python-version }}"
           allow-prereleases: true
 
       - name: Install dependencies
@@ -78,7 +79,8 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
+          allow-prereleases: true
 
       - name: Install dependencies
         run: |
@@ -97,6 +99,7 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: "3.10"
+          allow-prereleases: true
 
       - name: Install dependencies
         run: |

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,11 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 ### Added
 
 - A middleware `django_twc_toolbox.middleware.WwwRedirectMiddleware` for redirecting any request from a "www." subdomain to the bare domain. All credit to [Adam Johnson](https://github.com/adamchainz) -- [How to Make Django Redirect WWW to Your Bare Domain - Adam Johnson](https://adamj.eu/tech/2020/03/02/how-to-make-django-redirect-www-to-your-bare-domain/).
+- Now supporting Django 5.1.
+
+### Changed
+
+- Bumped `django-twc-package` template version to v2024.27.
 
 ### Fixed
 

diff --git a/README.md b/README.md
@@ -2,15 +2,15 @@
 
 [![PyPI](https://img.shields.io/pypi/v/django-twc-toolbox)](https://pypi.org/project/django-twc-toolbox/)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-twc-toolbox)
-![Django Version](https://img.shields.io/badge/django-4.2%20%7C%205.0-%2344B78B?labelColor=%23092E20)
+![Django Version](https://img.shields.io/badge/django-4.2%20%7C%205.0%20%7C%205.1-%2344B78B?labelColor=%23092E20)
 <!-- https://shields.io/badges -->
-<!-- django-4.2 | 5.0-#44B78B -->
+<!-- django-4.2 | 5.0 | 5.1-#44B78B -->
 <!-- labelColor=%23092E20 -->
 
 ## Requirements
 
 - Python 3.10, 3.11, 3.12, 3.13
-- Django 4.2, 5.0
+- Django 4.2, 5.0, 5.1
 
 ## Installation
 

diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -1,7 +1,9 @@
-// no idea if this will screw a lot up with the furo theme
-// but this does fix the line of badges in the README. only
-// one of them has a link which furo makes the vertical-align
-// different than just a standard img
+/*
+no idea if this will screw a lot up with the furo theme
+but this does fix the line of badges in the README. only
+one of them has a link which furo makes the vertical-align
+different than just a standard img
+*/
 p a.reference img {
-    vertical-align: inherit;
+  vertical-align: inherit;
 }
diff --git a/docs/conf.py b/docs/conf.py
@@ -40,10 +40,10 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "autodoc2",
     "myst_parser",
     "sphinx_copybutton",
     "sphinx_inline_tabs",
-    "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
 ]
 
@@ -59,10 +59,14 @@
 # -- MyST configuration ------------------------------------------------------
 myst_heading_anchors = 3
 
+# -- Options for autodoc2 -----------------------------------------------------
+autodoc2_packages = [f"../src/{project.replace('-', '_')}"]
+autodoc2_render_plugin = "myst"
+
+# -- Options for sphinx_copybutton -----------------------------------------------------
 copybutton_selector = "div.copy pre"
 copybutton_prompt_text = "$ "
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

diff --git a/docs/development/contributing.md b/docs/development/contributing.md
@@ -0,0 +1,5 @@
+```{include} ../../CONTRIBUTING.md
+
+```
+
+See the [documentation](./just.md) for more information.
diff --git a/docs/development/releasing.md b/docs/development/releasing.md
@@ -0,0 +1,3 @@
+```{include} ../../RELEASING.md
+
+```
diff --git a/docs/index.md b/docs/index.md
@@ -2,10 +2,20 @@
 
 ```
 
+```{toctree}
+:hidden:
+:maxdepth: 3
+:caption: API Reference
+
+apidocs/django_twc_toolbox/django_twc_toolbox.rst
+```
+
 ```{toctree}
 :hidden:
 :maxdepth: 3
 :caption: Development
 
+development/contributing.md
 development/just.md
+Releasing <development/releasing.md>
 ```
diff --git a/noxfile.py b/noxfile.py
@@ -18,9 +18,10 @@
 
 DJ42 = "4.2"
 DJ50 = "5.0"
+DJ51 = "5.1"
 DJMAIN = "main"
 DJMAIN_MIN_PY = PY310
-DJ_VERSIONS = [DJ42, DJ50, DJMAIN]
+DJ_VERSIONS = [DJ42, DJ50, DJ51, DJMAIN]
 DJ_LTS = [DJ42]
 DJ_DEFAULT = DJ_LTS[0]
 DJ_LATEST = DJ_VERSIONS[-2]

diff --git a/pyproject.toml b/pyproject.toml
@@ -9,6 +9,7 @@ classifiers = [
   "Framework :: Django",
   "Framework :: Django :: 4.2",
   "Framework :: Django :: 5.0",
+  "Framework :: Django :: 5.1",
   "License :: OSI Approved :: MIT License",
   "Operating System :: OS Independent",
   "Programming Language :: Python",
@@ -64,6 +65,7 @@ docs = [
   "myst-parser",
   "sphinx",
   "sphinx-autobuild",
+  "sphinx-autodoc2",
   "sphinx-copybutton",
   "sphinx-inline-tabs"
 ]

diff --git a/tests/conftest.py b/tests/conftest.py
@@ -9,7 +9,7 @@
 
 from .settings import DEFAULT_SETTINGS
 
-pytest_plugins = []  # type: ignore
+pytest_plugins = []
 
 
 def pytest_configure(config):

diff --git a/tests/test_conf.py b/tests/test_conf.py
@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+import pytest
+
+from django_twc_toolbox.conf import app_settings
+
+
+def test_app_settings():
+    # stub test until `django-twc-toolbox` requires custom app settings
+    with pytest.raises(AttributeError):
+        assert app_settings.foo