Skip to main content

Cloudflare Turnstile integration for Wagtail forms

Project description

Wagtail Turnstile

A lightweight Cloudflare Turnstile integration for Wagtail form pages.
Drop-in support with minimal configuration — and no Google reCAPTCHA required.

PyPI - Python Version License: MIT


Features

  • Adds a Turnstile field type to Wagtail’s form builder
  • Validates Turnstile submissions server-side

Installation

pip install wagtail-turnstile

Then add it to your Django settings:

INSTALLED_APPS = [
    ...
    "turnstile",
]

Add your Cloudflare Turnstile site and secret keys to your settings.py:

TURNSTILE_SITE_KEY = "your-site-key"
TURNSTILE_SECRET_KEY = "your-secret-key"

Usage

Here's a sample contact form page and field. Subclassing TurnstileAbstractFormField will add a new form field type, labelled to the user as "Captcha". This will handle the challenge and validation flow with Turnstile.

from turnstile.models import TurnstileAbstractFormField, TurnstileFormBuilder

class FormField(TurnstileAbstractFormField):
    page = ParentalKey(
        "ContactPage",
        on_delete=models.CASCADE,
        related_name="form_fields"
    )

class ContactPage(AbstractEmailForm):
    form_builder = TurnstileFormBuilder

Todo

Quite a lot, I would assume. It probably needs to be more customisable, and we don't need to store the Turnstile token.

Got any suggestions?

Feel free to raise an issue, and if you have a fix, submit a merge request and I'll be glad to take a look.

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

wagtail_turnstile-0.5.0.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wagtail_turnstile-0.5.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file wagtail_turnstile-0.5.0.tar.gz.

File metadata

  • Download URL: wagtail_turnstile-0.5.0.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for wagtail_turnstile-0.5.0.tar.gz
Algorithm Hash digest
SHA256 bb5f068415d835a5adb904cc09803e0cca7a9cee249eeb4af709ab4b57f35552
MD5 cf0e33faeb181d15cc819725b47c2ca2
BLAKE2b-256 42445bfa0fb04a1c963508d146e83f45975fa7298f352a4e03b6297e58486213

See more details on using hashes here.

Provenance

The following attestation bundles were made for wagtail_turnstile-0.5.0.tar.gz:

Publisher: publish.yml on soundslocalcic/wagtail-turnstile

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wagtail_turnstile-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for wagtail_turnstile-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2e5b13246629f8bc0173adf52f079e631310df1c8c63f14a522573dc6b12956e
MD5 7618471e59eff53b285b8dfddb49d817
BLAKE2b-256 91d5e1db04480cef499ac8d16d6510e0e69e88e25142ab35dd13754ae7732c99

See more details on using hashes here.

Provenance

The following attestation bundles were made for wagtail_turnstile-0.5.0-py3-none-any.whl:

Publisher: publish.yml on soundslocalcic/wagtail-turnstile

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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