Add Django 5.0 support and update with a blank test (#32)

* Poetry updates * Update to test locally with tox * Add tox tests to CI * Separate dependencies into groups * Update makefile command * Remove deprecated warning * Update CI task * Add an empty test * Add a TODO
uktrade · Dec 5, 2023 · e2d2199 · e2d2199
1 parent b4aa46d
commit e2d2199
Show file tree

Hide file tree

Showing 11 changed files with 928 additions and 594 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,26 @@
+name: Python package
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install poetry
+        run: |
+          pip install -U pip
+          pip install poetry
+          poetry install --with testing
+        env:
+          POETRY_VIRTUALENVS_CREATE: false
+      - name: Run Tox
+        run: poetry run tox
diff --git a/example_project/Makefile b/example_project/Makefile
@@ -3,7 +3,7 @@ SHELL := /bin/bash
 manage = poetry run python manage.py
 
 build:
-	poetry install
+	poetry install --with dev --with docs --with testing
 
 init:
 	$(manage) loaddata example/fixtures/test_users.json

diff --git a/example_project/poetry.lock b/example_project/poetry.lock
diff --git a/govuk_frontend_django/tests/__init__.py b/govuk_frontend_django/tests/__init__.py
diff --git a/govuk_frontend_django/tests/test_templatetags.py b/govuk_frontend_django/tests/test_templatetags.py
@@ -0,0 +1,3 @@
+# TODO: Add some tests
+def test_empty():
+    assert True
diff --git a/makefile b/makefile
@@ -53,4 +53,9 @@ mypy:
 	poetry run mypy govuk_frontend_django
 
 djlint:
-	poetry run djlint example_project --reformat
+	poetry run djlint example_project --reformat
+
+# Testing
+
+tox:
+	poetry run tox
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -17,8 +17,8 @@ homepage = "https://uktrade.github.io/govuk-frontend-django/"
 repository = "https://github.com/uktrade/govuk-frontend-django/"
 documentation = "https://uktrade.github.io/govuk-frontend-django/"
 packages = [
-    {include = "govuk_frontend_django"},
-    {include = "govuk_frontend_django/py.typed"},
+    { include = "govuk_frontend_django" },
+    { include = "govuk_frontend_django/py.typed" },
 ]
 
 [tool.poetry.dependencies]
@@ -27,6 +27,16 @@ Django = "^4.1.9"
 jinja2 = "^3.1.2"
 govuk-frontend-jinja = "2.7.0"
 
+[tool.poetry.group.testing]
+optional = true
+
+[tool.poetry.group.testing.dependencies]
+tox = "^4.11.4"
+pytest = "^7.4.3"
+
+[tool.poetry.group.dev]
+optional = true
+
 [tool.poetry.group.dev.dependencies]
 black = "^23.3.0"
 pyyaml = "^6.0"
@@ -36,6 +46,9 @@ mypy = "^1.2.0"
 django-stubs = "^1.16.0"
 djlint = "^1.28.0"
 
+[tool.poetry.group.docs]
+optional = true
+
 [tool.poetry.group.docs.dependencies]
 mkdocs-material = "^9.1.5"
 mkdocs-minify-plugin = "^0.6.4"
@@ -56,8 +69,8 @@ plugins = ["mypy_django_plugin.main"]
 django_settings_module = "settings"
 
 [tool.djlint]
-profile="django"
-indent="4"
-ignore="H021,H006"
-exclude="node_modules,staticfiles,static"
-custom_blocks="gds_accordion,gds_accordion_item,gds_breadcrumbs,gds_checkboxes,gds_checkbox_conditional,gds_cookie_banner,gds_cookie_banner_message,gds_error_summary,gds_error_summary_error_list_item,gds_footer,gds_footer_nav,gds_footer_meta,gds_header,gds_header_nav_item,gds_phase_banner,gds_summary_list,gds_summary_list_row,gds_summary_list_row_key,gds_summary_list_row_value,gds_summary_list_row_actions,gds_summary_list_row_actions_item,gds_summary_list_card,gds_summary_list_card_actions,gds_summary_list_card_actions_item,gds_tabs,gds_tabs_tab"
+profile = "django"
+indent = "4"
+ignore = "H021,H006"
+exclude = "node_modules,staticfiles,static"
+custom_blocks = "gds_accordion,gds_accordion_item,gds_breadcrumbs,gds_checkboxes,gds_checkbox_conditional,gds_cookie_banner,gds_cookie_banner_message,gds_error_summary,gds_error_summary_error_list_item,gds_footer,gds_footer_nav,gds_footer_meta,gds_header,gds_header_nav_item,gds_phase_banner,gds_summary_list,gds_summary_list_row,gds_summary_list_row_key,gds_summary_list_row_value,gds_summary_list_row_actions,gds_summary_list_row_actions_item,gds_summary_list_card,gds_summary_list_card_actions,gds_summary_list_card_actions_item,gds_tabs,gds_tabs_tab"
diff --git a/pytest.ini b/pytest.ini
@@ -1,3 +1,4 @@
 [pytest]
 
 DJANGO_SETTINGS_MODULE=settings
+norecursedirs=example_project
diff --git a/settings.py b/settings.py
@@ -31,6 +31,5 @@
 LANGUAGE_CODE = "en-us"
 TIME_ZONE = "UTC"
 USE_I18N = True
-USE_L10N = True
 USE_TZ = True
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
diff --git a/tox.ini b/tox.ini
@@ -1,6 +1,11 @@
 [tox]
 envlist =
-    dj{32,40,41,latest}
+    py{38,39,310,311}-dj{32}
+    py{38,39,310}-dj{40}
+    py{38,39,310,311}-dj{41}
+    py{38,39,310,311,312}-dj{42}
+    py{310,311,312}-dj{50,latest}
+skip_missing_interpreters = True
 
 [testenv]
 deps=
@@ -10,6 +15,8 @@ deps=
     dj32: Django>=3.2,<3.3
     dj40: Django>=4.0,<4.1
     dj41: Django>=4.1,<4.2
+    dj42: Django>=4.2,<5.0
+    dj50: Django>=5.0,<5.1
     djlatest: Django
 
 commands=