Django app that builds `template` and `elements` components from the Government Digital Services style guide
Project description
It should be easy to make a Django-based service that follows Government Digital Services’ style guide and reference materials. But https://pypi.python.org/pypi/govuk-template is not kept updated and is not readily usable in Django and https://github.com/alphagov/govuk_template cannot be installed directly into a Django project without complex build steps.
This package takes components published by GDS and creates an app in a Django project which can then be used as normal. This process downloads a release from https://github.com/alphagov/govuk_template and the contents of Node.js packages https://www.npmjs.com/package/govuk-elements-sass and https://www.npmjs.com/package/govuk_frontend_toolkit
Usage
Setup a Django project using manage.py startproject or other means
Install django-govuk-template and add govuk_template_base to INSTALLED_APPS
- Call manage.py startgovukapp [[app name, e.g. govuk_template]]
Add this app to INSTALLED_APPS
Ensure that this app is included in source control as the intention is that it’s only rebuilt as needed
If an update is needed in the future, delete the app created in previous step and run this command again
Add govuk_template_base.context_processors.govuk_template_base to the template context processors
Use [[app name, e.g. govuk_template]].html as the template to extend from and overrive the inner_content block
See the demo folder in this repository on GitHub, it is not included in distributions.
Additionally, add django-govuk-forms to your project to output Django forms styled using GOV.UK elements. You can install this package automatically by adding django-govuk-template[forms] to your requirements file.
Development
Please report bugs and open pull requests on GitHub.
Use python setup.py test to run all tests.
This repository does not need to be updated for every release of GDS’s packages, only breaking changes for overridden components may need fixes.
If any localisable strings change, run python setup.py makemessages compilemessages.
Distribute a new version to PyPi by updating the VERSION tuple in govuk_template_base and run python setup.py compilemessages sdist bdist_wheel upload.
To do
Improve SCSS building mechanism and add print CSS
It would be nice to require as few external tools as possible (e.g. docker/node/ruby) to make building simpler
Add browser-sync / watchdog components for easier local development using testserver
Add additional GOV.UK patterns
Copyright
Copyright © 2017 HM Government (Ministry of Justice Digital Services). See LICENSE.txt for further details.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django-govuk-template-0.3.tar.gz.
File metadata
- Download URL: django-govuk-template-0.3.tar.gz
- Upload date:
- Size: 19.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c564487057f9d8ca0a2ea4b3c652660e175683ea591083965991e6d8537009b7
|
|
| MD5 |
7f10e505be5deae2d2abd1422b464fcb
|
|
| BLAKE2b-256 |
4bc9c9d33cb03bb2f702ade1c74b9fcc5c135cbc7e90339d8c2ad4c75371bfa4
|
File details
Details for the file django_govuk_template-0.3-py3-none-any.whl.
File metadata
- Download URL: django_govuk_template-0.3-py3-none-any.whl
- Upload date:
- Size: 27.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d3cc9a38f11c98185823a98705e2f7071da66c9b14586ef8dad3191c096b4ac1
|
|
| MD5 |
7186f680b07b8c3c7628799c42e47417
|
|
| BLAKE2b-256 |
e12dffd6973eec0bd23bf82bb5806fa4d769a3a95a53b4b55da9ef1aeca959a7
|
