Skip to main content

Wagtail forms in a streamfield

Project description

CircleCI Codecov

Allows you to build forms in the CMS admin area and add them to any StreamField in your site. You can create your own types of forms meaning an endless array of possibilities. Templates can be created which will then appear as choices when you build your form, allowing you to display and submit a form however you want.

Backwards Compatibility

If you are using a version of wagtail 1.x, then the latest compatible version of this package is 1.6.3:

$ pip install wagtailstreamforms<2

Other wise you must install a version of this package from 2 onwards:

$ pip install wagtailstreamforms>=2

What else is included?

  • Customise things like success and error messages, post submit redirects and more.

  • Forms are processed via a before_page_serve hook. Meaning there is no fuss like remembering to include a page mixin.

  • The hook can easily be disabled to provide the ability to create your own.

  • Forms are categorised by their class in the CMS admin for easier navigation.

  • Form submissions are also listed by their form which you can filter by date and are ordered by newest first.

  • You can add site wide regex validators for use in regex fields.

  • A form and its fields can easily be copied to a new form.

  • There is a template tag that can be used to render a form, in case you want it to appear outside a StreamField.

  • Recaptcha can be added to a form.

Documentation

Can be found on readthedocs.

Screenshots

http://wagtailstreamforms.readthedocs.io/en/latest/_images/screen7.png

Example Front End

http://wagtailstreamforms.readthedocs.io/en/latest/_images/screen1.png

Menu

Example site with docker

Clone the repo

$ git clone https://github.com/AccentDesign/wagtailstreamforms.git

Run the docker container

$ cd wagtailstreamforms
$ docker-compose up

Create yourself a superuser

$ docker exec -it <container_name> bash
$ python manage.py createsuperuser

Go to http://127.0.0.1:8000

Testing

Install dependencies

You will need pyenv installed see https://github.com/pyenv/pyenv

Also tox needs to be installed

$ pip install tox

Install python versions in pyenv

$ pyenv install 3.4.4
$ pyenv install 3.5.3
$ pyenv install 3.6.2

Set local project versions

$ pyenv local 3.4.4 3.5.3 3.6.2

Run the tests

$ tox

or run for a single environment

$ tox -e py36-dj200-wt200

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtailstreamforms-2.1.1.tar.gz (22.0 kB view details)

Uploaded Source

File details

Details for the file wagtailstreamforms-2.1.1.tar.gz.

File metadata

File hashes

Hashes for wagtailstreamforms-2.1.1.tar.gz
Algorithm Hash digest
SHA256 45ba2102731ac7833a2ee5716ca670cfb98a53891338d595f67fae8f7733e6bd
MD5 dd849d35259e85c47816184ac944b67b
BLAKE2b-256 31aca86c4ae707f512261d204aed6143a58a3f7f8d637d4212b625fbf691c352

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page