Metadata-Version: 2.4
Name: dj-design-system
Version: 0.1.1
Summary: A Design System for Django
Project-URL: Homepage, https://django-design-system.github.io/django_design_system/
Project-URL: Repository, https://github.com/Django-Design-System/django_design_system
Project-URL: Documentation, https://django-design-system.github.io/django_design_system/
Project-URL: Bug Tracker, https://github.com/Django-Design-System/django_design_system/issues
Project-URL: Changelog, https://github.com/Django-Design-System/django_design_system/blob/main/CHANGELOG.md
Maintainer: marcelkornblum, CamLamb
License: MIT
License-File: LICENSE
Keywords: Design System,component,django
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.2
Classifier: Framework :: Django :: 6.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: User Interfaces
Requires-Python: >=3.13
Requires-Dist: django<8,>=5.2
Requires-Dist: markdown
Provides-Extra: dev
Requires-Dist: djlint; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: types-markdown; extra == 'dev'
Requires-Dist: types-pygments; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocstrings-python; extra == 'docs'
Provides-Extra: testing
Requires-Dist: coverage; extra == 'testing'
Requires-Dist: factory-boy; extra == 'testing'
Requires-Dist: playwright; extra == 'testing'
Requires-Dist: pytest-cov; extra == 'testing'
Requires-Dist: pytest-django; extra == 'testing'
Requires-Dist: pytest-mock; extra == 'testing'
Requires-Dist: pytest-playwright; extra == 'testing'
Description-Content-Type: text/markdown

# dj-design-system

[![CI](https://github.com/Django-Design-System/django_design_system/actions/workflows/ci.yml/badge.svg)](https://github.com/Django-Design-System/django_design_system/actions/workflows/ci.yml)
[![PyPI version](https://img.shields.io/pypi/v/dj-design-system)](https://pypi.org/project/dj-design-system/)
[![Python versions](https://img.shields.io/pypi/pyversions/dj-design-system)](https://pypi.org/project/dj-design-system/)
[![Django](https://img.shields.io/badge/django-5.2%20%7C%206.0%20%7C%20latest-green)](https://www.djangoproject.com/)
[![License: MIT](https://img.shields.io/badge/license-MIT-yellow)](LICENSE)

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.

**[Browse the demo →](https://django-design-system.github.io/django_design_system/demo/)**

**[Read the docs →](https://django-design-system.github.io/django_design_system/)**.

## Quick start

```bash
pip install dj-design-system
```

Then follow the [quickstart guide](https://django-design-system.github.io/django_design_system/quickstart/) 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/](https://django-design-system.github.io/django_design_system/)**.

To browse locally:

```bash
just docs-serve
```

| Document                              | Contents                                  |
| ------------------------------------- | ----------------------------------------- |
| [Quick start](docs/quickstart.md)     | Installation and first component          |
| [Components](docs/components.md)      | Defining components and parameters        |
| [Registry](docs/registry.md)          | Auto-discovery and the component registry |
| [Gallery](docs/gallery.md)            | Configuring and customising the gallery   |
| [Template tags](docs/templatetags.md) | Using components in templates             |
| [API reference](docs/api/)            | 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/](https://django-design-system.github.io/django_design_system/demo/)** (HTMX interactions disabled; run `just demo` for the full live experience).

## Contributing

See [CONTRIBUTING.md](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](https://www.contributor-covenant.org/). Please read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) before contributing.

## Issues and feature requests

Please open an issue on [GitHub](https://github.com/Django-Design-System/django_design_system/issues). Use the bug report template for defects and the feature request template for new ideas.

## Security

To report a vulnerability privately, see [SECURITY.md](SECURITY.md).

## Licence

[MIT](LICENSE)

With thanks to the UK [Department for Business and Trade](https://github.com/uktrade), where this was originally developed.
