README.rst
1===================
2django-crispy-forms
3===================
4
5.. image:: https://github.com/django-crispy-forms/django-crispy-forms/workflows/C/I%20Testing./badge.svg
6
7.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
8 :target: https://github.com/psf/black
9
10.. image:: http://codecov.io/github/django-crispy-forms/django-crispy-forms/coverage.svg?branch=main
11 :target: http://codecov.io/github/django-crispy-forms/django-crispy-forms?branch=main
12
13The 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.
14
15`django-crispy-forms` supports Django 2.2, 3.1, 3.2 and 4.0 with Python 3.6+.
16
17**Note: Django 4.0 requires version 1.13+.**
18
19Looking for Bootstrap 5 support? See the `crispy-bootstrap5 package`_.
20
21.. _`crispy-bootstrap5 package`: https://github.com/django-crispy-forms/crispy-bootstrap5
22
23The application mainly provides:
24
25* 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.
26* 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.
27
28Django-crispy-forms supports several frontend frameworks, such as Twitter `Bootstrap`_ (versions 2, 3, and 4), `Uni-form`_ 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.
29
30.. _`Uni-form`: http://sprawsm.com/uni-form
31.. _`Bootstrap`: https://getbootstrap.com
32.. _`see the docs`: https://django-crispy-forms.readthedocs.io
33
34Authors
35=======
36
37django-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.
38
39If you are upgrading from django-uni-form, we have `instructions`_ for helping you.
40
41* Lead developer: `Miguel Araujo`_
42
43.. _`Daniel Greenfeld`: https://github.com/pydanny
44.. _`Miguel Araujo`: https://github.com/maraujop
45.. _`instructions`: https://django-crispy-forms.readthedocs.io/en/latest/install.html#moving-from-django-uni-form-to-django-crispy-forms
46
47Example
48=======
49
50This is a teaser of what you can do with latest django-crispy-forms. `Find here the gist`_ for generating this form:
51
52.. image:: http://i.imgur.com/LSREg.png
53
54.. _`Find here the gist`: https://gist.github.com/1838193
55
56Documentation
57=============
58
59For extensive documentation see the ``docs`` folder or `read it on readthedocs`_
60
61.. _`read it on readthedocs`: https://django-crispy-forms.readthedocs.io/en/latest/index.html
62
63Special thanks
64==============
65
66* To Daniel Feldroy (`@pydanny`_) for his support, time and the opportunity given to me to do this.
67* The name of the project was suggested by the fantastic Audrey Feldroy (`@audreyfeldroy`_)
68* To Kenneth Love (`@kennethlove`_) for creating django-uni-form-contrib from which bootstrap template pack was started.
69
70.. _`@audreyfeldroy`: https://github.com/audreyfeldroy
71.. _`@pydanny`: https://github.com/pydanny
72.. _`@kennethlove`: https://github.com/kennethlove
73
74
75.. _Django: http://djangoproject.com
76
