A Design System for Django
Project description
dj-design-system
DjDS is a Django-native approach to writing front end components that are exposed as templatetags. It comes with an auto-generated, customisable, live interactive gallery of your UI components that lives 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 dj-design-system
Then follow the quickstart guide to register your first component.
Supported versions
| Python | Django |
|---|---|
| 3.13 | 5.2 (LTS) |
| 3.14 | 6.0 |
| latest |
Documentation
Full documentation is available at django-design-system.github.io/django_design_system/.
To browse locally:
just docs-serve
| Document | Contents |
|---|---|
| Quick start | Installation and first component |
| Components | Defining components and parameters |
| Registry | Auto-discovery and the component registry |
| Gallery | Configuring and customising the gallery |
| Template tags | Using components in templates |
| API reference | Auto-generated class and parameter docs |
A static snapshot of the component gallery is browseable at django-design-system.github.io/django_design_system/demo/ (HTMX interactions disabled; run just demo for the full live experience).
Contributing
See CONTRIBUTING.md for how to set up a dev environment, run tests, and submit a pull request.
Code of conduct
This project follows the Contributor Covenant. Please read CODE_OF_CONDUCT.md before contributing.
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
With thanks to the UK Department for Business and Trade, where this was originally developed.
Release history Release notifications | RSS feed
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file dj_design_system-0.2.0.tar.gz.
File metadata
- Download URL: dj_design_system-0.2.0.tar.gz
- Upload date:
- Size: 308.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
237204656e9b36dac98325ee387c86a0e8172c2f606920c13cfa12d44f2ec24f
|
|
| MD5 |
11dbb205dfc0ff17d0a9a4314ef3df8d
|
|
| BLAKE2b-256 |
35a3d16ead8fe1368be20b7b72927284655b0ab1c428b364118a059e65480b94
|
File details
Details for the file dj_design_system-0.2.0-py3-none-any.whl.
File metadata
- Download URL: dj_design_system-0.2.0-py3-none-any.whl
- Upload date:
- Size: 108.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b351cfa0c306c4c7a92ff544d8b27d4ee605aaa9cfd1ed91d2ccade2c1cd425d
|
|
| MD5 |
6317173b510098a3fef9b970919e391a
|
|
| BLAKE2b-256 |
b8d527ff4bddb308e889dbdba7dfcf2adce31802b509366b46eb54acfce5c97a
|
