ggds-django 0.2.0__tar.gz

ggds_django-0.2.0/.gitignore

@@ -0,0 +1,24 @@
+node_modules/
+dist/
+site/
+test-results/
+playwright-report/
+.DS_Store
+
+# Copied into each package when it is packed (scripts/package-files.mjs)
+packages/*/LICENSE
+packages/*/LICENSE.md
+
+# Release files (scripts/release.mjs)
+release/
+
+# ggds-django: its Python environment, and the files build.mjs copies in (pnpm run build)
+packages/django/.venv/
+packages/django/src/ggds_django/static/
+packages/django/src/ggds_django/icons.json
+__pycache__/
+
+# ggds-wordpress: the files build.mjs copies in (pnpm run build)
+packages/wordpress/ggds/assets/
+packages/wordpress/ggds/LICENSE
+packages/wordpress/ggds/LICENSE.md

ggds_django-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ggds_django-0.2.0/LICENSE.md

@@ -0,0 +1,25 @@
+# Licence
+
+GGDS code is licensed under the **Apache License, Version 2.0**. The full text is in [`LICENSE`](LICENSE).
+This was decided on 9 November 2026 (decision D-10 of the GGDS assessment).
+
+"Code" means everything in this repository except the marks listed below: tokens, CSS, JavaScript, the reference
+HTML, the documentation site and its build scripts, and the tests.
+
+## Not covered by the licence
+
+The Apache licence does **not** cover these. They are not licensed by this repository under any terms:
+
+- the national flag of Ghana and its colours as a national symbol;
+- the coat of arms of Ghana and other national emblems (Armed Forces Council, Coat of Arms and National Flag
+  Act, 1959 (No. 61); see decision D-03);
+- the names, logos and other marks of MoCDTI and its agencies, including the logos shown on the agency theme
+  pages.
+
+Using a GGDS theme does not give anyone the right to use an agency's name or logo, or to present a website as a
+Government of Ghana website.
+
+## Contributions
+
+Contributions are accepted under the same licence, with a Developer Certificate of Origin sign-off on every
+commit. See [`CONTRIBUTING.md`](CONTRIBUTING.md).

ggds_django-0.2.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.5
+Name: ggds-django
+Version: 0.2.0
+Summary: Ghana Government Design System (GGDS) for Django: page parts as template tags, a form renderer, and the GGDS styles and script.
+Project-URL: Documentation, https://github.com/ghana-gds/ggds
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: LICENSE.md
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 6.0
+Requires-Python: >=3.10
+Requires-Dist: django>=5.0
+Description-Content-Type: text/markdown
+
+# ggds-django
+
+The [Ghana Government Design System](https://github.com/ghana-gds/ggds) (GGDS) for Django: the page parts as
+template tags, a form renderer that turns any Django form into GGDS markup with correct error handling, the GGDS
+styles, themes and script as static files, and GGDS colours and header for Django admin. Django 5.0 or later. Works
+with Wagtail and other Django-based CMSs.
+
+**Documentation:** [ghana-gds.github.io/ggds](https://ghana-gds.github.io/ggds/) · [Use it with Django](https://ghana-gds.github.io/ggds/get-started/developers.html#django) · [Versions and support](https://ghana-gds.github.io/ggds/versions.html)
+
+## Set up
+
+```python
+INSTALLED_APPS = [..., "django.contrib.staticfiles", "ggds_django"]
+FORM_RENDERER = "ggds_django.forms.GGDSFormRenderer"   # every form in GGDS markup
+TEMPLATES = [{..., "OPTIONS": {"context_processors": [..., "django.template.context_processors.request"]}}]
+```
+
+To use GGDS for some forms only, leave `FORM_RENDERER` out and add `GGDSFormMixin` to those forms.
+
+## A page
+
+```django
+{% load ggds %}<!doctype html>
+<html lang="en-GB">
+<head>
+  <meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>{% ggds_error_title form "Make a complaint" %} | Example Agency</title>
+  {% ggds_assets theme="nca" %}
+</head>
+<body>
+{% ggds_skip_link %}
+{% ggds_banner short_name="NCA" host="nca.org.gh" official=is_official %}
+{% ggds_header name="National Communications Authority" nav=nav %}
+<main id="main" tabindex="-1" class="ggds-container ggds-main">
+  {% ggds_breadcrumbs crumbs %}
+  <h1>Make a complaint</h1>
+  <form method="post">{% csrf_token %}
+    {{ form }}
+    <button class="ggds-button">Send complaint</button>
+  </form>
+</main>
+{% ggds_footer name="National Communications Authority" sections=sections links=footer_links %}
+{% ggds_tab_bar tabs %}
+</body>
+</html>
+```
+
+Links are dicts (`{"label": "Services", "href": "/services/"}`) or `("Services", "/services/")` pairs. The header
+marks the section the page's address is in; the tab bar marks the current tab.
+
+## Forms
+
+With the renderer, `{{ form }}` shows an error summary after a failed submit (focused on load by the GGDS
+script, each item linking to its field, a radio group's to its first option), then every field:
+
+| Django widget | GGDS markup |
+|---|---|
+| Text, email, number, date… | `ggds-field` with label, hint (`help_text`), error and `ggds-input` |
+| `Textarea`, `Select`, `FileInput` | the same with `ggds-textarea`, `ggds-select`, `ggds-file-upload` |
+| `RadioSelect`, `CheckboxSelectMultiple` | a `ggds-fieldset` with a legend and `ggds-choices` |
+| `CheckboxInput` | a single `ggds-choice` |
+| `GGDSDateField` | a `ggds-fieldset` with day, month and year boxes (`ggds-date-input`) |
+
+Each control gets `aria-describedby` (hint, then error) and, with an error, `aria-invalid="true"`. Errors start
+with a hidden "Error:". Fields that are not required say "(optional)". Set `autocomplete` on personal details with
+the widget's `attrs`. One field: `{{ form.phone.as_field_group }}`.
+
+### Dates people know
+
+```python
+from ggds_django.forms import GGDSDateField
+
+class ApplicationForm(forms.Form):
+    date_of_birth = GGDSDateField(label="What is your date of birth?", name="date of birth", birthday=True,
+                                  help_text="For example, 27 3 1990")
+```
+
+`cleaned_data["date_of_birth"]` is a `datetime.date`. The month can be typed as 3, 03, March or Mar. Errors use
+`name`: "Enter date of birth", "Date of birth must include a year", "Year must include 4 numbers", "Date of birth
+must be a real date", and with `birthday=True` or `past=True`, "Date of birth must be in the past". Only the boxes
+with the problem are marked invalid, and the error summary links to the first of them. `birthday=True` also adds
+`autocomplete="bday-day"` and so on.
+
+## Page parts
+
+| Tag | |
+|---|---|
+| `{% ggds_assets theme="nca" %}` | Stylesheet, theme and optional script, in `<head>` |
+| `{% ggds_skip_link %}` | First thing in `<body>` |
+| `{% ggds_banner short_name host official %}` | Government website banner |
+| `{% ggds_header name nav %}` | Logo or initials, name, sections, Search |
+| `{% ggds_hero title purpose lede search_action tasks %}` | Homepage hero |
+| `{% ggds_breadcrumbs crumbs %}` | Trail ending with the current page |
+| `{% ggds_summary_list rows %}` | Check answers: rows of `{"key", "value", "href"}`; an empty value shows "Not given", and each Change link says what it changes. `plain=True` for no lines |
+| `{% ggds_panel "Complaint sent" reference=ref %}` | Confirmation panel: the page's `<h1>` and the reference number |
+| `{% ggds_pagination page_obj %}` | From Django's `Paginator`; keeps other query parameters |
+| `{% ggds_footer name purpose address email phone sections links %}` | Footer |
+| `{% ggds_tab_bar tabs %}` | Phone quick links: each tab has an `icon` |
+| `{% ggds_error_summary form %}` | On its own, for forms you lay out yourself |
+
+Everything else (buttons, notices, tags, cards, tables) is plain GGDS HTML: copy it from the documentation.
+
+## Django admin
+
+Admin keeps its own layout but takes GGDS's colours, type, focus style and header (the flag-colour rule and the
+institution's logo or initials, name and country), from the GGDS tokens and your institution's theme:
+
+```python
+INSTALLED_APPS = [..., "ggds_django", "ggds_django.admin_theme", "django.contrib.admin", ...]  # above admin
+GGDS_ADMIN = {
+    "theme": "nca",                                 # a file in ggds/themes/, as for {% ggds_assets %}
+    "name": "National Communications Authority",    # default: the admin site's site_header
+    "initials": "NCA",                              # or "logo_url" and "logo_alt"
+    "country": "Republic of Ghana",                 # the default; "" for none
+}
+```
+
+It loads the tokens on their own (`ggds/tokens.css`), never the GGDS base styles, which would restyle admin's
+elements. Admin is shown light only: the dark palette and the theme toggle are left out. `manage.py check` warns if
+the app is below `django.contrib.admin`, a key is misspelt or the theme does not exist.
+
+## Content added after load
+
+HTMX, fetch or a script that adds a GGDS menu or error summary should call `initAll(element)` from the GGDS script
+(`ggds/js/index.js`) on the new content.
+
+## Develop
+
+From the GGDS repository: `pnpm run build` copies the tokens, styles, themes, script and icons into the app;
+`pnpm run test:django` runs the tests (including a check that the markup matches the GGDS documentation) and renders
+an example site into the documentation build, where the accessibility tests check it.

ggds_django-0.2.0/README.md

@@ -0,0 +1,131 @@
+# ggds-django
+
+The [Ghana Government Design System](https://github.com/ghana-gds/ggds) (GGDS) for Django: the page parts as
+template tags, a form renderer that turns any Django form into GGDS markup with correct error handling, the GGDS
+styles, themes and script as static files, and GGDS colours and header for Django admin. Django 5.0 or later. Works
+with Wagtail and other Django-based CMSs.
+
+**Documentation:** [ghana-gds.github.io/ggds](https://ghana-gds.github.io/ggds/) · [Use it with Django](https://ghana-gds.github.io/ggds/get-started/developers.html#django) · [Versions and support](https://ghana-gds.github.io/ggds/versions.html)
+
+## Set up
+
+```python
+INSTALLED_APPS = [..., "django.contrib.staticfiles", "ggds_django"]
+FORM_RENDERER = "ggds_django.forms.GGDSFormRenderer"   # every form in GGDS markup
+TEMPLATES = [{..., "OPTIONS": {"context_processors": [..., "django.template.context_processors.request"]}}]
+```
+
+To use GGDS for some forms only, leave `FORM_RENDERER` out and add `GGDSFormMixin` to those forms.
+
+## A page
+
+```django
+{% load ggds %}<!doctype html>
+<html lang="en-GB">
+<head>
+  <meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>{% ggds_error_title form "Make a complaint" %} | Example Agency</title>
+  {% ggds_assets theme="nca" %}
+</head>
+<body>
+{% ggds_skip_link %}
+{% ggds_banner short_name="NCA" host="nca.org.gh" official=is_official %}
+{% ggds_header name="National Communications Authority" nav=nav %}
+<main id="main" tabindex="-1" class="ggds-container ggds-main">
+  {% ggds_breadcrumbs crumbs %}
+  <h1>Make a complaint</h1>
+  <form method="post">{% csrf_token %}
+    {{ form }}
+    <button class="ggds-button">Send complaint</button>
+  </form>
+</main>
+{% ggds_footer name="National Communications Authority" sections=sections links=footer_links %}
+{% ggds_tab_bar tabs %}
+</body>
+</html>
+```
+
+Links are dicts (`{"label": "Services", "href": "/services/"}`) or `("Services", "/services/")` pairs. The header
+marks the section the page's address is in; the tab bar marks the current tab.
+
+## Forms
+
+With the renderer, `{{ form }}` shows an error summary after a failed submit (focused on load by the GGDS
+script, each item linking to its field, a radio group's to its first option), then every field:
+
+| Django widget | GGDS markup |
+|---|---|
+| Text, email, number, date… | `ggds-field` with label, hint (`help_text`), error and `ggds-input` |
+| `Textarea`, `Select`, `FileInput` | the same with `ggds-textarea`, `ggds-select`, `ggds-file-upload` |
+| `RadioSelect`, `CheckboxSelectMultiple` | a `ggds-fieldset` with a legend and `ggds-choices` |
+| `CheckboxInput` | a single `ggds-choice` |
+| `GGDSDateField` | a `ggds-fieldset` with day, month and year boxes (`ggds-date-input`) |
+
+Each control gets `aria-describedby` (hint, then error) and, with an error, `aria-invalid="true"`. Errors start
+with a hidden "Error:". Fields that are not required say "(optional)". Set `autocomplete` on personal details with
+the widget's `attrs`. One field: `{{ form.phone.as_field_group }}`.
+
+### Dates people know
+
+```python
+from ggds_django.forms import GGDSDateField
+
+class ApplicationForm(forms.Form):
+    date_of_birth = GGDSDateField(label="What is your date of birth?", name="date of birth", birthday=True,
+                                  help_text="For example, 27 3 1990")
+```
+
+`cleaned_data["date_of_birth"]` is a `datetime.date`. The month can be typed as 3, 03, March or Mar. Errors use
+`name`: "Enter date of birth", "Date of birth must include a year", "Year must include 4 numbers", "Date of birth
+must be a real date", and with `birthday=True` or `past=True`, "Date of birth must be in the past". Only the boxes
+with the problem are marked invalid, and the error summary links to the first of them. `birthday=True` also adds
+`autocomplete="bday-day"` and so on.
+
+## Page parts
+
+| Tag | |
+|---|---|
+| `{% ggds_assets theme="nca" %}` | Stylesheet, theme and optional script, in `<head>` |
+| `{% ggds_skip_link %}` | First thing in `<body>` |
+| `{% ggds_banner short_name host official %}` | Government website banner |
+| `{% ggds_header name nav %}` | Logo or initials, name, sections, Search |
+| `{% ggds_hero title purpose lede search_action tasks %}` | Homepage hero |
+| `{% ggds_breadcrumbs crumbs %}` | Trail ending with the current page |
+| `{% ggds_summary_list rows %}` | Check answers: rows of `{"key", "value", "href"}`; an empty value shows "Not given", and each Change link says what it changes. `plain=True` for no lines |
+| `{% ggds_panel "Complaint sent" reference=ref %}` | Confirmation panel: the page's `<h1>` and the reference number |
+| `{% ggds_pagination page_obj %}` | From Django's `Paginator`; keeps other query parameters |
+| `{% ggds_footer name purpose address email phone sections links %}` | Footer |
+| `{% ggds_tab_bar tabs %}` | Phone quick links: each tab has an `icon` |
+| `{% ggds_error_summary form %}` | On its own, for forms you lay out yourself |
+
+Everything else (buttons, notices, tags, cards, tables) is plain GGDS HTML: copy it from the documentation.
+
+## Django admin
+
+Admin keeps its own layout but takes GGDS's colours, type, focus style and header (the flag-colour rule and the
+institution's logo or initials, name and country), from the GGDS tokens and your institution's theme:
+
+```python
+INSTALLED_APPS = [..., "ggds_django", "ggds_django.admin_theme", "django.contrib.admin", ...]  # above admin
+GGDS_ADMIN = {
+    "theme": "nca",                                 # a file in ggds/themes/, as for {% ggds_assets %}
+    "name": "National Communications Authority",    # default: the admin site's site_header
+    "initials": "NCA",                              # or "logo_url" and "logo_alt"
+    "country": "Republic of Ghana",                 # the default; "" for none
+}
+```
+
+It loads the tokens on their own (`ggds/tokens.css`), never the GGDS base styles, which would restyle admin's
+elements. Admin is shown light only: the dark palette and the theme toggle are left out. `manage.py check` warns if
+the app is below `django.contrib.admin`, a key is misspelt or the theme does not exist.
+
+## Content added after load
+
+HTMX, fetch or a script that adds a GGDS menu or error summary should call `initAll(element)` from the GGDS script
+(`ggds/js/index.js`) on the new content.
+
+## Develop
+
+From the GGDS repository: `pnpm run build` copies the tokens, styles, themes, script and icons into the app;
+`pnpm run test:django` runs the tests (including a check that the markup matches the GGDS documentation) and renders
+an example site into the documentation build, where the accessibility tests check it.

ggds_django-0.2.0/build.mjs

@@ -0,0 +1,22 @@
+// Copies the built GGDS tokens, styles, themes and script into the Django app's static files, and the shared icons into
+// icons.json, so the Django package serves exactly what the other GGDS packages do. Run after the CSS, theme and
+// JavaScript builds (pnpm run build does).
+import { cpSync, mkdirSync, rmSync, writeFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { ICONS } from '../astro/icons.mjs';
+
+const here = dirname(fileURLToPath(import.meta.url));
+const app = join(here, 'src', 'ggds_django');
+const out = join(app, 'static', 'ggds');
+const packages = join(here, '..');
+
+rmSync(out, { recursive: true, force: true });
+mkdirSync(out, { recursive: true });
+cpSync(join(packages, 'css', 'dist'), out, { recursive: true });
+// The tokens on their own, with no element styles: for pages GGDS does not lay out, such as Django admin.
+cpSync(join(packages, 'tokens', 'dist', 'tokens.css'), join(out, 'tokens.css'));
+cpSync(join(packages, 'themes', 'dist'), join(out, 'themes'), { recursive: true, filter: (f) => !f.endsWith('.json') });
+cpSync(join(packages, 'js', 'dist'), join(out, 'js'), { recursive: true, filter: (f) => !f.endsWith('.d.ts') });
+writeFileSync(join(app, 'icons.json'), `${JSON.stringify(ICONS, null, 1)}\n`);
+console.log(`django: static files and icons → ${app}`);

ggds_django-0.2.0/demo/render.py

@@ -0,0 +1,79 @@
+"""Renders a small example site with ggds-django into the documentation build (site/django/), where the
+accessibility, Content Security Policy and layout tests check it like every other page.
+
+    python demo/render.py <site directory>
+"""
+import shutil
+import sys
+from pathlib import Path
+
+import django
+from django.conf import settings
+
+HERE = Path(__file__).parent
+settings.configure(
+    INSTALLED_APPS=["django.contrib.staticfiles", "ggds_django"],
+    TEMPLATES=[{"BACKEND": "django.template.backends.django.DjangoTemplates", "DIRS": [HERE / "templates"], "APP_DIRS": True,
+                "OPTIONS": {"context_processors": ["django.template.context_processors.request"]}}],
+    FORM_RENDERER="ggds_django.forms.GGDSFormRenderer",
+    STATIC_URL="/django/static/",  # the example site is served from site/django/
+    ALLOWED_HOSTS=["*"],
+)
+django.setup()
+
+from django import forms  # noqa: E402
+from django.core.paginator import Paginator  # noqa: E402
+from django.template.loader import render_to_string  # noqa: E402
+from django.test import RequestFactory  # noqa: E402
+
+
+class ComplaintForm(forms.Form):
+    name = forms.CharField(label="Full name", help_text="As on your Ghana Card",
+                           widget=forms.TextInput(attrs={"autocomplete": "name", "spellcheck": "false"}))
+    phone = forms.CharField(label="Phone number", help_text="We call or text you about this only",
+                            widget=forms.TextInput(attrs={"type": "tel", "autocomplete": "tel"}))
+    email = forms.EmailField(label="Email address", required=False, widget=forms.EmailInput(attrs={"autocomplete": "email"}))
+    provider = forms.ChoiceField(label="Which provider is it about?", choices=[("", "Choose a provider"), ("a", "Provider A"), ("b", "Provider B")])
+    contact = forms.ChoiceField(label="How should we contact you?", widget=forms.RadioSelect,
+                                choices=[("call", "Phone call"), ("sms", "SMS"), ("email", "Email")])
+    topics = forms.MultipleChoiceField(label="What is it about?", required=False, widget=forms.CheckboxSelectMultiple,
+                                       choices=[("net", "Internet"), ("calls", "Calls"), ("sms", "SMS")])
+    details = forms.CharField(label="What happened?", help_text="Include dates. Do not include your PIN or passwords.", widget=forms.Textarea(attrs={"rows": 5}))
+    agree = forms.BooleanField(label="I confirm the details are true")
+
+
+NAV = [{"label": "Services", "href": "form.html"}, {"label": "Search", "href": "search.html"}, {"label": "About", "href": "index.html#main"}]
+CONTEXT = {
+    "nav": NAV,
+    "tasks": [{"label": "Make a complaint", "href": "form.html"}, {"label": "See search results", "href": "search.html"}],
+    "sections": [{"label": "Services", "href": "form.html", "links": [{"label": "Make a complaint", "href": "form.html"}]},
+                 {"label": "Search", "href": "search.html", "links": [{"label": "Search results", "href": "search.html"}]}],
+    "bar": [{"label": "Accessibility", "href": "index.html"}, {"label": "Privacy", "href": "index.html"}],
+    "tabs": [{"label": "Home", "href": "index.html", "icon": "home"}, {"label": "Services", "href": "form.html", "icon": "services"},
+             {"label": "Search", "href": "search.html", "icon": "search"}],
+}
+
+
+def render(out: Path, name: str, template: str, path: str, **extra):
+    request = RequestFactory().get(path)
+    html = render_to_string(template, {**CONTEXT, **extra}, request=request)
+    (out / name).write_text(html)
+
+
+def main(site: str):
+    out = Path(site) / "django"
+    shutil.rmtree(out, ignore_errors=True)
+    out.mkdir(parents=True)
+    shutil.copytree(HERE.parent / "src" / "ggds_django" / "static", out / "static")
+    crumbs = lambda label: [("Home", "index.html"), (label, "")]  # noqa: E731
+    render(out, "index.html", "demo/index.html", "/", title="Home")
+    render(out, "form.html", "demo/form.html", "/services/", title="Make a complaint", form=ComplaintForm(), crumbs=crumbs("Make a complaint"))
+    bad = ComplaintForm(data={"email": "not-an-email", "provider": ""})
+    render(out, "form-errors.html", "demo/form.html", "/services/", title="Error: Make a complaint", form=bad, crumbs=crumbs("Make a complaint"))
+    page = Paginator(list(range(1, 101)), 10).page(5)
+    render(out, "search.html", "demo/list.html", "/search/?q=licence&page=5", title="Search results", page_obj=page, crumbs=crumbs("Search results"))
+    print(f"django: example site → {out}")
+
+
+if __name__ == "__main__":
+    main(sys.argv[1])

ggds_django-0.2.0/demo/templates/demo/base.html

@@ -0,0 +1,23 @@
+{% load ggds %}<!doctype html>
+<html lang="en-GB">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>{{ title }} | Example Agency (Django example)</title>
+  <meta name="robots" content="noindex, nofollow">
+  {% ggds_assets theme="nca" %}
+</head>
+<body>
+{% ggds_skip_link %}
+{% ggds_banner short_name="Example Agency" host="example.gov.gh" register_href="../register.html" %}
+{% ggds_header name="Example Agency" nav=nav search_url="search.html" home="index.html" %}
+<main id="main" tabindex="-1">
+{% block hero %}{% endblock %}
+<div class="ggds-container ggds-main">
+{% block content %}{% endblock %}
+</div>
+</main>
+{% ggds_footer name="Example Agency" purpose="An example site rendered by Django with ggds-django." sections=sections links=bar contact_url="form.html" %}
+{% ggds_tab_bar tabs %}
+</body>
+</html>