Skip to main content

Wagtail StreamForms

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.

Installation

$ pip install wagtailstreamforms

or, in a project managed with uv:

$ uv add wagtailstreamforms

Then follow the installation guide.

Compatibility

wagtailstreamforms

Wagtail

Django

Python

5.3

7.0 - 8.x

5.2, 6.0, 6.1 [1]

3.10 - 3.14

5.1 - 5.2

6.0 - 7.x

as supported by Wagtail

3.9+

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

Development

The project is managed with uv.

$ git clone https://github.com/labd/wagtailstreamforms.git
$ cd wagtailstreamforms
$ make install   # uv sync --all-groups
$ make test      # run the test suite against the locked versions
$ make tox       # run the full Python/Django/Wagtail matrix via tox-uv
$ make format    # ruff
$ make docs      # build the Sphinx documentation

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

Metadata

Release files for wagtailstreamforms 5.3.0

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.3.0
File Size Uploaded Provenance
wagtailstreamforms-5.3.0.tar.gz 38.2 kB Without provenance Details

Built distribution (wheel)

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

Total release size: 91.2 kB

Release files / wagtailstreamforms-5.3.0.tar.gz

Download URL wagtailstreamforms-5.3.0.tar.gz
Size 38.2 kB
Tags Source
SHA-256 checksum
How to use checksums
4c07e419f3b73d4a41a8d1e0cd353d40430e6cf462f63d2898b703d04b68a271
BLAKE2b-256 checksum
How to use checksums
ab48bb17875ee54f0e365150d252fae848a9ba65978f88ec7862d3ffecdbf114
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

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

Download URL wagtailstreamforms-5.3.0-py3-none-any.whl
Size 53.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7f7f74971d8ee900623989609b897d8736b926b8e7312c15e6d7f0aef1b66962
BLAKE2b-256 checksum
How to use checksums
ddef0410e9530db16e9c6519c61f810976706e0aad6c8658746dc11d5b019b07
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Security for wagtailstreamforms 5.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

5.3.0 This release

2 release files No provenance

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