django-design-system
A Django-native approach to writing front end components that are exposed as templatetags. Comes with an auto-generated, customisable live interactive gallery of your UI components alongside your Django project.
Components are recognisably Django elements; they look and work like Models or Forms. The gallery auto-discovers them, renders live previews in sandboxed iframes, generates templatetag usage examples, and builds a searchable navigation tree — all from your existing code and docstrings.
Quick start
pip install django-design-system
Then follow the quickstart guide to register your first component.
Documentation
Full documentation lives in the docs/ directory and can be browsed locally with:
make docs-serve
| Document | Contents |
|---|---|
| docs/quickstart.md | Installation and first component |
| docs/components.md | Defining components and parameters |
| docs/registry.md | Auto-discovery and the component registry |
| docs/gallery.md | Configuring and customising the gallery |
| docs/templatetags.md | Using components in templates |
Contributing
See CONTRIBUTING.md for how to set up a dev environment, run tests, and submit a pull request.
Issues and feature requests
Please open an issue on GitHub. Use the bug report template for defects and the feature request template for new ideas.
Security
To report a vulnerability privately, see SECURITY.md.
Licence
1 maintainer
Metadata
1 maintainer
Release files for uktrade-intranet-design-system 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| uktrade_intranet_design_system-0.0.1.tar.gz | 147.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| uktrade_intranet_design_system-0.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 249.3 kB
Release files / uktrade_intranet_design_system-0.0.1.tar.gz
| Download URL | uktrade_intranet_design_system-0.0.1.tar.gz |
|---|---|
| Size | 147.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6d2c941f2ae1007ddae20318f79a85a80eb75207af7628863d45ed04401bae67
|
|
BLAKE2b-256 checksum How to use checksums |
ce3c85bbdd9a7eb960edabfa5a1d951e3945b26ff79dcc405c7e8bb1052d1a42
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.2 CPython/3.13.5 Linux/5.15.0-1104-aws-fips
|
Release files / uktrade_intranet_design_system-0.0.1-py3-none-any.whl
| Download URL | uktrade_intranet_design_system-0.0.1-py3-none-any.whl |
|---|---|
| Size | 101.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4e018f4c0a7a8f5ce9243f75326ba1880d2a896b97d4b552e46357ce1ea105d4
|
|
BLAKE2b-256 checksum How to use checksums |
9964d7fb691b352213ddc079b0c958c2347a1841c795f186875ce63075cf07a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.2 CPython/3.13.5 Linux/5.15.0-1104-aws-fips
|
