Metadata-Version: 2.3
Name: uktrade-intranet-design-system
Version: 0.0.1
Summary: A Design System for Django used by UKTrade
License: MIT
Keywords: django,Design System,component
Maintainer: Marcel Kornblum
Maintainer-email: marcel.kornblum@businessandtrade.gov.uk
Requires-Python: >=3.13,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.2
Classifier: Framework :: Django :: 6
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-Dist: django (>=5.2,<5.3)
Requires-Dist: markdown (>=3.10.2,<4.0.0)
Description-Content-Type: text/markdown

# django-design-system

[![Unit tests](https://github.com/uktrade/django-design-system/actions/workflows/test.yml/badge.svg)](https://github.com/uktrade/django-design-system/actions/workflows/test.yml)
[![Lint](https://github.com/uktrade/django-design-system/actions/workflows/lint.yml/badge.svg)](https://github.com/uktrade/django-design-system/actions/workflows/lint.yml)
[![Python 3.13+](https://img.shields.io/badge/python-3.13%2B-blue)](https://www.python.org/)
[![Django 5.2+](https://img.shields.io/badge/django-5.2%2B-green)](https://www.djangoproject.com/)
[![License: MIT](https://img.shields.io/badge/license-MIT-yellow)](LICENSE)

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

```bash
pip install django-design-system
```

Then follow the [quickstart guide](docs/quickstart.md) to register your first component.

## Documentation

Full documentation lives in the [`docs/`](docs/) directory and can be browsed locally with:

```bash
make docs-serve
```

| Document                                     | Contents                                  |
| -------------------------------------------- | ----------------------------------------- |
| [docs/quickstart.md](docs/quickstart.md)     | Installation and first component          |
| [docs/components.md](docs/components.md)     | Defining components and parameters        |
| [docs/registry.md](docs/registry.md)         | Auto-discovery and the component registry |
| [docs/gallery.md](docs/gallery.md)           | Configuring and customising the gallery   |
| [docs/templatetags.md](docs/templatetags.md) | Using components in templates             |

## Contributing

See [CONTRIBUTING.md](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](https://github.com/uktrade/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)

