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.1.0.tar.gz (9.7 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.1.0-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wagtail_turnstile-0.1.0.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for wagtail_turnstile-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1d842886f12a175bd31b6a1df421c4609dca9f4de9d62b479f3e543ba7c3d761
MD5 d5f5bb7cdf7b69470429166e62360699
BLAKE2b-256 697c51b9028c52da143dcee744078e2fafffaa48752ec9d957d359f6e52f0b27

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wagtail_turnstile-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23df689d7c30d9c58f0179a48cbd8b5eb93104939ed3d13d674b4c6d28255382
MD5 26c67a6f5af048441cfcc769e9ec43e8
BLAKE2b-256 788fda30aec48314652782b6dd257646e43a586d567ac768a8e40edd1eb81f99

See more details on using hashes here.

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