Skip to content

jazzband/django-formtools

Repository files navigation

django-formtools

Jazzband PyPI version Supported Python versions GitHub Actions Test Coverage

Django's "formtools" is a set of high-level abstractions for Django forms. Currently for form previews and multi-step forms.

This code used to live in Django proper -- in django.contrib.formtools -- but was separated into a standalone package in Django 1.8 to keep the framework's core clean.

For a full list of available formtools, see https://django-formtools.readthedocs.io/

django-formtools can also be found on and installed from the Python Package Index: https://pypi.python.org/pypi/django-formtools

To get more help:

Contributing to django-formtools

See CONTRIBUTING.rst for information about contributing patches to django-formtools.

Running tests is as simple as installing Tox and running it in the root Git clone directory:

$ git clone https://github.com/jazzband/django-formtools
[..]
$ cd django-formtools
$ tox
[..]
  congratulations :)

The previous command will run the tests in different combinations of Python (if available) and Django versions. To see the full list of combinations use the -l option:

$ tox -l
...
py310-djangoAB
py310-djangomain

You can run each environment with the -e option:

$ tox -e py310-djangoAB  # runs the tests only on Python 3.10 and Django A.B.x

Optionally you can also specify a country whose tests you want to run:

$ COUNTRY=us tox

And combine both options:

$ COUNTRY=us tox -e py310-djangoAB