Skip to main content

A module for Django that allows to build pattern libraries for your projects.

Project description

django-pattern-library

PyPI PyPI downloads Build status

UI pattern libraries for Django templates. Try our online demo.

Screenshot of the pattern library UI, with navigation, pattern rendering, and configuration

Features

This package automates the maintenance of UI pattern libraries or styleguides for Django projects, and allows developers to experiment with Django templates without having to create Django views and models.

  • Create reusable patterns by creating Django templates files as usual.
  • All patterns automatically show up in the pattern library’s interface.
  • Define data as YAML files for the templates to render with the relevant Django context.
  • Override Django templates tags as needed to mock the template’s dependencies.
  • Document your patterns with Markdown.

Why you need this

Pattern libraries will change your workflow for the better:

  • They help separate concerns, both in code, and between members of a development team.
  • If needed, they make it possible for UI development to happen before models and views are created.
  • They encourage code reuse – defining independent UI components, that can be reused across apps, or ported to other projects.
  • It makes it much simpler to test UI components – no need to figure out where they’re used across a site or app.

Learn more by watching our presentation – Reusable UI components: A journey from React to Wagtail.

Online demo

The pattern library is dependent on Django for rendering – but also supports exporting as a static site if needed. Try out our online demo:

Documentation

Documentation is available at torchbox.github.io/django-pattern-library, with source files in the docs directory.

Contributing

See anything you like in here? Anything missing? We welcome all support, whether on bug reports, feature requests, code, design, reviews, tests, documentation, and more. Please have a look at our contribution guidelines.

If you want to set up the project on your own computer, the contribution guidelines also contain all of the setup commands.

Nightly builds

To try out the latest features before a release, we also create builds from every commit to main. Note we make no guarantee as to the quality of those pre-releases, and the pre-releases are overwritten on every build so shouldn’t be relied on for reproducible builds. Download the latest django_pattern_library-0.0.0.dev0-py3-none-any.whl.

Credits

View the full list of contributors. BSD licensed.

Project logo from FxEmoji. Documentation website built with MkDocs, and hosted in GitHub Pages.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_pattern_library-1.2.0.tar.gz (30.4 kB view details)

Uploaded Source

Built Distribution

django_pattern_library-1.2.0-py3-none-any.whl (33.1 kB view details)

Uploaded Python 3

File details

Details for the file django_pattern_library-1.2.0.tar.gz.

File metadata

  • Download URL: django_pattern_library-1.2.0.tar.gz
  • Upload date:
  • Size: 30.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.12 Linux/5.15.0-91-generic

File hashes

Hashes for django_pattern_library-1.2.0.tar.gz
Algorithm Hash digest
SHA256 dd4ce104947bbfc7e227873afe442da9e961c68663f7b8fe50d16fc86ba906b3
MD5 fc55b1612dc592049dcf66dec00583b4
BLAKE2b-256 7700d1b3fcc61e39aaa5197b9c36a669aba489daa92f9d8c7c873ed0d70e71a8

See more details on using hashes here.

File details

Details for the file django_pattern_library-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_pattern_library-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7fa75d7a4251c08562fd6ec4bbb485bf12e1952d3ff12ba5692f35950be767a5
MD5 16e6c34224232bd93fbf780f3fec0cc4
BLAKE2b-256 46975f6f0734983b175bf9811c8a851544b2dc8f93e60d8d567213e8d37015aa

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page