wagtail-newsletter-django-backend 0.0.2__tar.gz → 0.2.0__tar.gz

{wagtail_newsletter_django_backend-0.0.2 → wagtail_newsletter_django_backend-0.2.0}/.gitignore

@@ -60,7 +60,7 @@ cover/
 *.log
 local_settings.py
 db.sqlite3
-db.sqlite3-journal
+db.sqlite3-*
 
 # Flask stuff:
 instance/
@@ -162,3 +162,4 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
+demo/media/

{wagtail_newsletter_django_backend-0.0.2 → wagtail_newsletter_django_backend-0.2.0}/PKG-INFO

@@ -1,14 +1,16 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: wagtail-newsletter-django-backend
-Version: 0.0.2
+Version: 0.2.0
 Summary: An internal Django backend to wagtail-newsletter.
 Author-email: "Taylor C. Richberger" <taylor@axfive.net>
 Maintainer-email: "Taylor C. Richberger" <taylor@axfive.net>
 Requires-Python: >= 3.10
 Description-Content-Type: text/markdown
-Requires-Dist: Django>=5.2,<5.3
-Requires-Dist: wagtail>=7.1,<7.2
-Requires-Dist: wagtail-newsletter>=0.2.2,<0.3.0
+License-File: LICENSE
+Requires-Dist: Django >=5.2, <5.3
+Requires-Dist: wagtail >=7.1, <7.2
+Requires-Dist: wagtail-newsletter >=0.2.2, <0.3.0
+Requires-Dist: html2text >= 2025.4.15
 Project-URL: documentation, https://wagtail-newsletter-django-backend.readthedocs.io/en/latest/
 Project-URL: repository, https://forge.axfive.net/Taylor/wagtail-newsletter-django-backend
 

wagtail_newsletter_django_backend-0.2.0/demo/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demo.settings.dev")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

wagtail_newsletter_django_backend-0.2.0/demo/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ['flit_core >= 3.2, <4']
+build-backend = 'flit_core.buildapi'
+
+[project]
+name = "demo"
+dynamic = ['version', 'description']
+dependencies = [
+  'Django>=5.2,<5.3',
+  'wagtail>=7.1,<7.2',
+  "wagtail-newsletter[mrml]>=0.2.2,<0.3.0",
+  "wagtail-newsletter-django-backend",
+  'python-dotenv',
+  "django-extensions",
+  'requests >= 2.32.5, < 3',
+]
+requires-python = ">=3.10"
+
+[dependency-groups]
+dev = [
+    "basedpyright>=1.31.2",
+    "django-types>=0.22.0",
+    "ptpython",
+]
+
+[[project.authors]]
+name = 'Taylor C. Richberger'
+email = 'taylor@axfive.net'
+
+[[project.maintainers]]
+name = 'Taylor C. Richberger'
+email = 'taylor@axfive.net'
+
+[tool.uv.sources]
+wagtail-newsletter-django-backend = { path = "../", editable = true }

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/__init__.py

@@ -0,0 +1,4 @@
+'''A demo site for wagtail-newsletter-django-backend.
+'''
+
+__version__ = '0.0.1'

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/blog/apps.py

@@ -0,0 +1,11 @@
+from typing import override
+from django.apps import AppConfig
+
+
+class BlogConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "demo.blog"
+
+    @override
+    def ready(self):
+        from . import signals

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/blog/migrations/0001_initial.py

@@ -0,0 +1,80 @@
+# Generated by Django 5.2.5 on 2025-09-01 20:37
+
+import django.db.models.deletion
+import wagtail.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("wagtail_newsletter", "0001_initial"),
+        ("wagtailcore", "0095_groupsitepermission"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="BlogIndexPage",
+            fields=[
+                (
+                    "page_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="wagtailcore.page",
+                    ),
+                ),
+                ("intro", wagtail.fields.RichTextField(blank=True)),
+            ],
+            options={
+                "abstract": False,
+            },
+            bases=("wagtailcore.page",),
+        ),
+        migrations.CreateModel(
+            name="BlogPage",
+            fields=[
+                (
+                    "page_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="wagtailcore.page",
+                    ),
+                ),
+                (
+                    "newsletter_subject",
+                    models.CharField(
+                        blank=True,
+                        help_text="Subject for the newsletter. Defaults to page title if blank.",
+                        max_length=1000,
+                    ),
+                ),
+                ("newsletter_campaign", models.CharField(blank=True, max_length=1000)),
+                ("date", models.DateField(verbose_name="Post date")),
+                ("intro", models.CharField(max_length=250)),
+                ("body", wagtail.fields.RichTextField(blank=True)),
+                (
+                    "newsletter_recipients",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        to="wagtail_newsletter.newsletterrecipients",
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+            },
+            bases=("wagtailcore.page",),
+        ),
+    ]

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/blog/migrations/0002_newslettersignup.py

@@ -0,0 +1,45 @@
+# Generated by Django 5.2.5 on 2025-09-01 22:31
+
+import django.db.models.deletion
+import wagtail.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("blog", "0001_initial"),
+        ("wagtail_newsletter_django_backend", "0001_initial"),
+        ("wagtailcore", "0095_groupsitepermission"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="NewsletterSignup",
+            fields=[
+                (
+                    "page_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="wagtailcore.page",
+                    ),
+                ),
+                ("intro", wagtail.fields.RichTextField(blank=True)),
+                (
+                    "audience",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="wagtail_newsletter_django_backend.audience",
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+            },
+            bases=("wagtailcore.page",),
+        ),
+    ]

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/blog/models.py

@@ -0,0 +1,62 @@
+from django.contrib import messages
+from django.db import models
+from django.shortcuts import redirect
+from django.conf import settings
+from wagtail import models as wt_models
+from wagtail import fields as wt_fields
+from wagtail.models.pages import HttpRequest, HttpResponse
+from wagtail_newsletter.models import NewsletterPageMixin
+import requests
+from wagtail_newsletter_django_backend.forms import SignupForm
+from wagtail_newsletter_django_backend.models import Audience, Subscriber
+
+class BlogIndexPage(wt_models.Page):
+    intro = wt_fields.RichTextField(blank=True)
+
+    content_panels = wt_models.Page.content_panels + ["intro"]
+
+class BlogPage(NewsletterPageMixin, wt_models.Page):
+    date = models.DateField("Post date")
+    intro = models.CharField(max_length=250)
+    body = wt_fields.RichTextField(blank=True)
+
+    content_panels = wt_models.Page.content_panels + ["date", "intro", "body"]
+
+    newsletter_template = 'blog/blog_page_newsletter.html'
+
+class NewsletterSignup(wt_models.Page):
+    intro = wt_fields.RichTextField(blank=True)
+
+    audience = models.ForeignKey(Audience, blank=False, null=False, on_delete=models.CASCADE)
+
+    content_panels = wt_models.Page.content_panels + ["intro", 'audience']
+
+    form: SignupForm | None = None
+
+    def serve(self, request: HttpRequest) -> HttpResponse:
+        if request.method != 'POST':
+            self.form = SignupForm(initial={'audience': self.audience}, audience=self.audience)
+            return super().serve(request=request)
+        self.form = SignupForm(request.POST, audience=self.audience)
+        token = request.POST['h-captcha-response']
+        params = {
+           "secret": settings.HCAPTCHA_SECRET,
+           "response": token
+        }
+        # TODO: add remoteip: https://docs.hcaptcha.com/#server
+        response = requests.post("https://hcaptcha.com/siteverify", data=params)
+        response.raise_for_status()
+        data = response.json()
+        if data['success']:
+            if self.form.is_valid():
+                _ = self.form.save()
+                messages.success(request, 'You have successfully signed up for the newsletter, and a welcome email has been sent.  You will not receive any messages until you validate your email address.')
+            else:
+                messages.error(request, 'form failed validation')
+        else:
+            messages.error(request, 'Captcha validation failed.  Error codes: ' + '\n'.join(data['error-codes']))
+        return super().serve(request=request)
+
+    def hcaptcha_site_id(self):
+        return settings.HCAPTCHA_SITE_ID
+

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/blog/signals.py

@@ -0,0 +1,13 @@
+import sqlite3
+from typing import Any
+from django.db.backends.signals import connection_created
+from django.dispatch import receiver
+
+@receiver(connection_created)
+def sqlite_pragmas(sender, connection: Any, **kwargs):
+    """Enable integrity constraint with sqlite."""
+    if connection.vendor == 'sqlite':
+        cursor = connection.cursor()
+        _ = cursor.execute('PRAGMA foreign_keys = ON')
+        _ = cursor.execute('PRAGMA journal_mode = WAL')
+        _ = cursor.execute('PRAGMA synchronous = NORMAL')

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/blog/templates/blog/blog_index_page.html

@@ -0,0 +1,19 @@
+{% extends "base.html" %}
+
+{% load wagtailcore_tags %}
+
+{% block body_class %}template-blogindexpage{% endblock %}
+
+{% block content %}
+    <h1>{{ page.title }}</h1>
+
+    <div class="intro">{{ page.intro|richtext }}</div>
+
+    {% for post in page.get_children %}
+        <h2><a href="{% pageurl post %}">{{ post.title }}</a></h2>
+        {{ post.specific.intro }}
+        {{ post.specific.body|richtext }}
+    {% endfor %}
+
+{% endblock %}
+

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/blog/templates/blog/blog_page.html

@@ -0,0 +1,17 @@
+{% extends "base.html" %}
+
+{% load wagtailcore_tags %}
+
+{% block body_class %}template-blogpage{% endblock %}
+
+{% block content %}
+    <h1>{{ page.title }}</h1>
+    <p class="meta">{{ page.date }}</p>
+
+    <div class="intro">{{ page.intro }}</div>
+
+    {{ page.body|richtext }}
+
+    <p><a href="{{ page.get_parent.url }}">Return to blog</a></p>
+
+{% endblock %}

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/blog/templates/blog/blog_page_newsletter.html

@@ -0,0 +1,19 @@
+{% load wagtail_newsletter %}
+
+{% mrml %}
+    <mjml>
+        <mj-body>
+            <mj-text>
+                <h1>{{ page.title }}</h1>
+                <p><a href="{{ page.full_url }}">Read this in a web browser.</a></p>
+                <div class="intro">{{ page.intro }}</div>
+            </mj-text>
+            {{ page.body|newsletter_richtext }}
+            <mj-text>
+                <p><a href="[[unsubscribe]]">Unsubscribe from all further emails.</a></p>
+                <p><a href="[[manage]]">Manage your subscription.</a></p>
+            </mj-text>
+        </mj-body>
+    </mjml>
+{% endmrml %}
+

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/blog/templates/blog/newsletter_signup.html

@@ -0,0 +1,21 @@
+{% extends "base.html" %}
+
+{% load wagtailcore_tags %}
+
+{% block body_class %}template-blogindexpage{% endblock %}
+{% block extra_js %}
+<script src="https://js.hcaptcha.com/1/api.js" async defer></script>
+{% endblock %}
+
+{% block content %}
+    <h1>{{ page.title }}</h1>
+
+    <div class="intro">{{ page.intro|richtext }}</div>
+
+    <form method="POST">{% csrf_token %}
+        {{ page.form.as_p }}
+        <div class="h-captcha" data-sitekey="{{ page.hcaptcha_site_id }}"></div>
+        <input type="submit" value="Sign Up">
+    </form>
+{% endblock %}
+

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/home/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class HomeConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "demo.home"

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/home/migrations/0001_initial.py

@@ -0,0 +1,36 @@
+# Generated by Django 5.2.5 on 2025-09-01 20:37
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("wagtailcore", "0095_groupsitepermission"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="HomePage",
+            fields=[
+                (
+                    "page_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="wagtailcore.page",
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+            },
+            bases=("wagtailcore.page",),
+        ),
+    ]

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/home/models.py

@@ -0,0 +1,7 @@
+from django.db import models
+
+from wagtail.models import Page
+
+
+class HomePage(Page):
+    pass

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/home/static/css/welcome_page.css

@@ -0,0 +1,184 @@
+html {
+    box-sizing: border-box;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body {
+    max-width: 960px;
+    min-height: 100vh;
+    margin: 0 auto;
+    padding: 0 15px;
+    color: #231f20;
+    font-family: 'Helvetica Neue', 'Segoe UI', Arial, sans-serif;
+    line-height: 1.25;
+}
+
+a {
+    background-color: transparent;
+    color: #308282;
+    text-decoration: underline;
+}
+
+a:hover {
+    color: #ea1b10;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+p,
+ul {
+    padding: 0;
+    margin: 0;
+    font-weight: 400;
+}
+
+svg:not(:root) {
+    overflow: hidden;
+}
+
+.header {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+    padding-top: 20px;
+    padding-bottom: 10px;
+    border-bottom: 1px solid #e6e6e6;
+}
+
+.logo {
+    width: 150px;
+    margin-inline-end: 20px;
+}
+
+.logo a {
+    display: block;
+}
+
+.figure-logo {
+    max-width: 150px;
+    max-height: 55.1px;
+}
+
+.release-notes {
+    font-size: 14px;
+}
+
+.main {
+    padding: 40px 0;
+    margin: 0 auto;
+    text-align: center;
+}
+
+.figure-space {
+    max-width: 265px;
+}
+
+@keyframes pos {
+    0%, 100% {
+        transform: rotate(-6deg);
+    }
+    50% {
+        transform: rotate(6deg);
+    }
+}
+
+.egg {
+    fill: #43b1b0;
+    animation: pos 3s ease infinite;
+    transform: translateY(50px);
+    transform-origin: 50% 80%;
+}
+
+.main-text {
+    max-width: 400px;
+    margin: 5px auto;
+}
+
+.main-text h1 {
+    font-size: 22px;
+}
+
+.main-text p {
+    margin: 15px auto 0;
+}
+
+.footer {
+    display: flex;
+    flex-wrap: wrap;
+    justify-content: space-between;
+    border-top: 1px solid #e6e6e6;
+    padding: 10px;
+}
+
+.option {
+    display: block;
+    padding: 10px 10px 10px 34px;
+    position: relative;
+    text-decoration: none;
+}
+
+.option svg {
+    width: 24px;
+    height: 24px;
+    fill: gray;
+    border: 1px solid #d9d9d9;
+    padding: 5px;
+    border-radius: 100%;
+    top: 10px;
+    inset-inline-start: 0;
+    position: absolute;
+}
+
+.option h2 {
+    font-size: 19px;
+    text-decoration: underline;
+}
+
+.option p {
+    padding-top: 3px;
+    color: #231f20;
+    font-size: 15px;
+    font-weight: 300;
+}
+
+@media (max-width: 996px) {
+    body {
+        max-width: 780px;
+    }
+}
+
+@media (max-width: 767px) {
+    .option {
+        flex: 0 0 50%;
+    }
+}
+
+@media (max-width: 599px) {
+    .main {
+        padding: 20px 0;
+    }
+
+    .figure-space {
+        max-width: 200px;
+    }
+
+    .footer {
+        display: block;
+        width: 300px;
+        margin: 0 auto;
+    }
+}
+
+@media (max-width: 360px) {
+    .header-link {
+        max-width: 100px;
+    }
+}

wagtail_newsletter_django_backend-0.2.0/demo/src/demo/home/templates/home/home_page.html

@@ -0,0 +1,21 @@
+{% extends "base.html" %}
+{% load static %}
+
+{% block body_class %}template-homepage{% endblock %}
+
+{% block extra_css %}
+
+{% comment %}
+Delete the line below if you're just getting started and want to remove the welcome screen!
+{% endcomment %}
+<link rel="stylesheet" href="{% static 'css/welcome_page.css' %}">
+{% endblock extra_css %}
+
+{% block content %}
+
+{% comment %}
+Delete the line below if you're just getting started and want to remove the welcome screen!
+{% endcomment %}
+{% include 'home/welcome_page.html' %}
+
+{% endblock content %}