Metadata-Version: 2.1
Name: crispy-tailwind
Version: 0.2.0
Summary: A tailwind package for Django Crispy Forms
Home-page: https://github.com/django-crispy-forms/crispy-tailwind
Author: David Smith
Author-email: smithdc@gmail.com
License: MIT
Keywords: forms,django,crispy,tailwind
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.5
Requires-Dist: django-crispy-forms (>=1.9.0)

===============
Crispy-Tailwind
===============

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

A Tailwind_ template pack for the wonderful django-crispy-forms_.

**WARNING**

This project is still in it's early stages of development and has not yet
been published to PyPI. If you would like to try out the package please
install from github directly. Any contributions to the package would be
very welcomed.

Currently the template pack allows the use of the ``|crispy`` filter to style
your form. Here is an example image.

.. image:: https://django-crispy-forms.github.io/crispy-tailwind/_images/crispy_form.png

How to install
--------------

Install via pip. ::

    pip install crispy-tailwind

You will need to update your project's settings file to add ``crispy_forms``
and ``crispy_tailwind`` to your projects ``INSTALLED_APPS``. Also set
``tailwind`` as and allowed template pack and as the default template pack
for your project::

    INSTALLED_APPS = (
        ...
        "crispy_forms",
        "crispy_tailwind",
        ...
    )

    CRISPY_ALLOWED_TEMPLATE_PACKS = "tailwind"

    CRISPY_TEMPLATE_PACK = "tailwind"

How to use
----------

This project is still in its early stages. Currently functionality allows
the ``|crispy`` filter to be used to style your form. In your template:

1. Load the filter ``{% load tailwind_filters %}``
2. Apply the crispy filter ``{{ form|crispy }}``

Documentation
-------------

The documentation for this project is available here:
https://django-crispy-forms.github.io/crispy-tailwind/index.html







.. _tailwind: https://tailwindcss.com/
.. _django-crispy-forms: https://github.com/django-crispy-forms/django-crispy-forms


