django-crispy-forms

=================== django-crispy-forms

.. image:: https://github.com/django-crispy-forms/django-crispy-forms/actions/workflows/main.yml/badge.svg

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black

.. image:: http://codecov.io/github/django-crispy-forms/django-crispy-forms/coverage.svg?branch=main :target: http://codecov.io/github/django-crispy-forms/django-crispy-forms?branch=main

The best way to have Django_ DRY forms. Build programmatic reusable layouts out of components, having full control of the rendered HTML without writing HTML in templates. All this without breaking the standard way of doing things in Django, so it plays nice with any other form application.

django-crispy-forms supports Django 4.2+ with Python 3.8+.

Looking for Bootstrap 5 support? See the crispy-bootstrap5 package_.

.. _crispy-bootstrap5 package: https://github.com/django-crispy-forms/crispy-bootstrap5

The application mainly provides:

• A filter named |crispy that will render elegant div based forms. Think of it as the built-in methods: as_table, as_ul and as_p. You cannot tune up the output, but it is easy to start using it.
• A tag named {% crispy %} that will render a form based on your configuration and specific layout setup. This gives you amazing power without much hassle, helping you save tons of time.

Django-crispy-forms supports several frontend frameworks, such as Twitter Bootstrap_ (versions 2, 3, and 4), tailwind, Bulma and Foundation. You can also easily adapt your custom company's one, creating your own, see the docs_ for more information. You can easily switch among them using CRISPY_TEMPLATE_PACK setting variable.

.. _tailwind: https://github.com/django-crispy-forms/crispy-tailwind .. _Bootstrap: https://getbootstrap.com .. _Bulma: https://github.com/ckrybus/crispy-bulma .. _see the docs: https://django-crispy-forms.readthedocs.io

Authors

django-crispy-forms is the new django-uni-form. django-uni-form was an application created by Daniel Greenfeld_ that I led since version 0.8.0. The name change tries to better explain the purpose of the application, which changed in a significant way since its birth.

If you are upgrading from django-uni-form, we have instructions_ for helping you.

• Lead developer: Miguel Araujo_

.. _Daniel Greenfeld: https://github.com/pydanny .. _Miguel Araujo: https://github.com/maraujop .. _instructions: https://django-crispy-forms.readthedocs.io/en/latest/install.html#moving-from-django-uni-form-to-django-crispy-forms

Example

This is a teaser of what you can do with latest django-crispy-forms. Find here the gist_ for generating this form:

.. image:: http://i.imgur.com/LSREg.png

.. _Find here the gist: https://gist.github.com/1838193

Documentation

For extensive documentation see the docs folder or read it on readthedocs_

.. _read it on readthedocs: https://django-crispy-forms.readthedocs.io/en/latest/index.html

Special thanks

• To Daniel Feldroy (@pydanny_) for his support, time and the opportunity given to me to do this.
• The name of the project was suggested by the fantastic Audrey Feldroy (@audreyfeldroy_)
• To Kenneth Love (@kennethlove_) for creating django-uni-form-contrib from which bootstrap template pack was started.

.. _@audreyfeldroy: https://github.com/audreyfeldroy .. _@pydanny: https://github.com/pydanny .. _@kennethlove: https://github.com/kennethlove

.. _Django: http://djangoproject.com