Skip to main content

tests Codecov pypi github

Allows you to build forms in the CMS admin area and add them to any StreamField in your site. You can add your own fields along with the vast array of default fields which include the likes of file fields. Form submissions are controlled by hooks that you can add that process the forms cleaned data. 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

Please note that due to this package being virtually re-written for version 3, you cannot upgrade any existing older version of this package to version 3 and onwards. If you have an existing version installed less than 3 then you will need to completely remove it including tables and any migrations that were applied in the databases django_migrations table.

Older versions:

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?

  • Each form is built using a StreamField.

  • 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.

  • Form submissions are controlled via hooks meaning you can easily create things like emailing the submission which you can turn on and off on each form.

  • Fields can easily be added to the form from your own code such as Recaptcha or a Regex Field.

  • The default set of fields can easily be replaced to add things like widget attributes.

  • You can define a model that will allow you to save additional settings for each form.

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

  • Files can also be submitted to the forms that are shown with the form submissions.

  • 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.

Documentation

Can be found on readthedocs.

Screenshots

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

Example Front End

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

Form Fields Selection

Example site with docker

Clone the repo

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

Run the docker container

$ cd wagtailstreamforms
$ docker-compose up

Create yourself a superuser

$ docker-compose exec app bash
$ python manage.py createsuperuser

Go to http://127.0.0.1:8000

Release files for wagtailstreamforms 5.2.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wagtailstreamforms 5.2.6
File Size Uploaded
wagtailstreamforms-5.2.6.tar.gz 36.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for wagtailstreamforms 5.2.6
File Interpreter ABI Platform
wagtailstreamforms-5.2.6-py3-none-any.whl Python 3 none any Details

Total release size: 88.9 kB

Release files / wagtailstreamforms-5.2.6.tar.gz

Download URL wagtailstreamforms-5.2.6.tar.gz
Size 36.6 kB
Tags Source
SHA-256 checksum
How to use checksums
2b8d8215a49f4e593d3ffc2465ca197d8d4818a4bdd05a65a44b9a7aae1679f6
BLAKE2b-256 checksum
How to use checksums
b4aa93746f32bb81fc288a140513a5cb4ac1842df4e7ac3eab2cd7ae6a261166
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / wagtailstreamforms-5.2.6-py3-none-any.whl

Download URL wagtailstreamforms-5.2.6-py3-none-any.whl
Size 52.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
923a3ebf942964e3955856d5a34139d4c53452c5a6ec4c6609887dc47ba30844
BLAKE2b-256 checksum
How to use checksums
32cf446cb2fd5927bd60875a3c4e34b67c58bf8e0af752638b0791df02d2a733
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

5.2.6 This release

2 release files

5.2.5

2 release files

5.2.4

2 release files

5.2.3

2 release files

5.2.2

2 release files

5.2.1

2 release files

5.2.0

2 release files

5.1.0

2 release files

5.0.1

2 release files

4.1.0

2 release files

4.0.5

2 release files

4.0.4

2 release files

4.0.3

2 release files

4.0.2

2 release files

4.0.1

2 release files

3.22

2 release files

3.21

2 release files

3.19

2 release files

3.18.1

2 release files

3.17

2 release files

3.16.3

2 release files

3.16.1

2 release files

3.15

2 release files

3.14

2 release files

3.13

2 release files

3.12

2 release files

3.11

2 release files

3.10

2 release files

3.9

2 release files

3.8

2 release files

3.7

1 release file

3.6.1

1 release file

3.5

1 release file

3.4

1 release file

3.3

1 release file

3.2

1 release file

3.1

1 release file

3.0

1 release file

2.1.2

1 release file

2.1.1

1 release file

2.1.0

1 release file

2.0.1

1 release file

2.0.0

1 release file

1.6.3

1 release file

1.6.2

1 release file

1.6.1

1 release file

1.6.0

1 release file

1.5.2

1 release file

1.5.1

1 release file

1.5.0

1 release file

1.4.4

1 release file

1.4.3

1 release file

1.4.2

1 release file

1.4.1

1 release file

1.4.0

1 release file

1.3.0

1 release file

1.2.3

1 release file

1.2.2

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.0

1 release file

0.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page