Skip to content

Latest commit

 

History

History
102 lines (70 loc) · 3 KB

README.rst

File metadata and controls

102 lines (70 loc) · 3 KB

django-floppyforms

Jazzband GitHub Actions Coverage

Full control of form rendering in the templates.

  • Authors: Gregor Müllegger and many many contributors
  • Original creator: Bruno Renié started this project and kept it going for many years.
  • Licence: BSD
  • Requirements: homework -- read this.

Installation

  • pip install -U django-floppyforms
  • Add floppyforms to your INSTALLED_APPS

For those who want to mix and match with vanilla Django widgets, it is also recommended to put Django's form template directory into your template directories:

# in your template configuration
TEMPLATES = [{
    ...,
    # inside the directories parameter
    'DIRS': [
        # include django's form templates
        os.path.join(
            os.path.dirname(django.__file__), "forms/templates/"
        ),
        ... # the rest of your template directories
}]

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

To install the in-development version of django-floppyforms, run pip install "https://github.com/jazzband/django-floppyforms/tarball/master#egg=django-floppyforms".

Help

Create a ticket in the issues section on github or ask your questions on the #django-floppyforms IRC channel on freenode.

You can get professional consulting regarding django-floppyforms or any other Django related work from django-floppyforms' maintainer Gregor Müllegger.

Bugs

Really? Oh well... Please Report. Or better, fix :) We are happy to help you through the process of fixing and testing a bug. Just get in touch.

Development

Thanks for asking!

Get the code:

git clone [email protected]:jazzband/django-floppyforms.git
cd django-floppyforms
virtualenv env
source env/bin/activate
add2virtualenv .

Install the development requirements:

pip install "tox>=1.8"

Currently, you'll need to install the GeoDjango requirements when running tests.

Run the tests:

tox
tox -e py36-22

You can see all the supported test configurations with tox -l.