sendery-django 0.1.0__tar.gz

sendery_django-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sendery contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sendery_django-0.1.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: sendery-django
+Version: 0.1.0
+Summary: Sendery template email client for Django
+License-Expression: MIT
+Project-URL: Documentation, https://sendery.co/en/docs/django
+Project-URL: Repository, https://github.com/sendery-co/sendery-django
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sendery<0.2,>=0.1
+Requires-Dist: Django<5.3,>=5.2
+Dynamic: license-file
+
+# Sendery for Django
+
+Send Sendery templates through Django’s email backend.
+
+[Documentation](https://sendery.co/en/docs/django) · [API reference](https://sendery.co/en/docs/send-email) · [Changelog](CHANGELOG.md)
+
+## Requirements
+
+Django 5.2 and Python 3.10+.
+
+## Install
+
+```bash
+pip install sendery-django
+```
+
+## Configure the backend
+
+Publish a `welcome` template with `name` and `action_url` variables, and create a [project API key](https://sendery.co/en/docs/authentication). Store it as `SENDERY_API_KEY` on your server. Add the backend and key to your Django settings.
+
+```python
+# settings.py
+import os
+
+EMAIL_BACKEND = "sendery_django.backend.EmailBackend"
+SENDERY_API_KEY = os.environ["SENDERY_API_KEY"]
+```
+
+## Send an email
+
+Use `TemplateEmail` with one recipient. Its `sendery_receipt` contains the accepted email’s ID and status. Ordinary `EmailMessage` objects, attachments, and `cc` or `bcc` recipients are not supported. Set the sender in your Sendery project.
+
+```python
+from sendery_django import TemplateEmail
+
+email = TemplateEmail(
+    to="alex@example.com",
+    template="welcome",
+    data={"name": "Alex", "action_url": "https://example.com/start"},
+)
+email.send(fail_silently=False)
+
+print(email.sendery_receipt["id"])
+```
+
+## Password resets
+
+Publish a `password-reset` template with `name` and `action_url`. Use `SenderyPasswordResetForm` with Django’s authentication views. Add these routes to your `urlpatterns` and provide Django’s standard password-reset HTML pages under `templates/registration/`. If the routes already exist, change only the reset view’s `form_class`.
+
+```python
+# urls.py
+from django.contrib.auth import views as auth_views
+from django.urls import path
+from sendery_django.forms import SenderyPasswordResetForm
+
+urlpatterns = [
+    path("password-reset/", auth_views.PasswordResetView.as_view(
+        form_class=SenderyPasswordResetForm,
+    ), name="password_reset"),
+    path("password-reset/done/", auth_views.PasswordResetDoneView.as_view(),
+         name="password_reset_done"),
+    path("reset/<uidb64>/<token>/", auth_views.PasswordResetConfirmView.as_view(),
+         name="password_reset_confirm"),
+    path("reset/done/", auth_views.PasswordResetCompleteView.as_view(),
+         name="password_reset_complete"),
+]
+```
+
+## Retry a send
+
+Keep `fail_silently=False` to receive [`SenderyError`](https://sendery.co/en/docs/python) on API failures. The backend makes one attempt. In a [background task](https://sendery.co/en/docs/queues), save the recipient, variables, and `idempotency_key` before sending and reuse them for retries.
+
+```python
+# Use the same saved recipient, variables, and event key on every attempt.
+email = TemplateEmail(
+    to="alex@example.com",
+    template="welcome",
+    data={"name": "Alex", "action_url": "https://example.com/start"},
+    idempotency_key="welcome-123",
+)
+email.send(fail_silently=False)
+```
+
+## More
+
+See [idempotency and retries](https://sendery.co/en/docs/idempotency) for retry conditions, delays, and reusing a key across attempts.
+
+## License
+
+[MIT](LICENSE).

sendery_django-0.1.0/README.md

@@ -0,0 +1,90 @@
+# Sendery for Django
+
+Send Sendery templates through Django’s email backend.
+
+[Documentation](https://sendery.co/en/docs/django) · [API reference](https://sendery.co/en/docs/send-email) · [Changelog](CHANGELOG.md)
+
+## Requirements
+
+Django 5.2 and Python 3.10+.
+
+## Install
+
+```bash
+pip install sendery-django
+```
+
+## Configure the backend
+
+Publish a `welcome` template with `name` and `action_url` variables, and create a [project API key](https://sendery.co/en/docs/authentication). Store it as `SENDERY_API_KEY` on your server. Add the backend and key to your Django settings.
+
+```python
+# settings.py
+import os
+
+EMAIL_BACKEND = "sendery_django.backend.EmailBackend"
+SENDERY_API_KEY = os.environ["SENDERY_API_KEY"]
+```
+
+## Send an email
+
+Use `TemplateEmail` with one recipient. Its `sendery_receipt` contains the accepted email’s ID and status. Ordinary `EmailMessage` objects, attachments, and `cc` or `bcc` recipients are not supported. Set the sender in your Sendery project.
+
+```python
+from sendery_django import TemplateEmail
+
+email = TemplateEmail(
+    to="alex@example.com",
+    template="welcome",
+    data={"name": "Alex", "action_url": "https://example.com/start"},
+)
+email.send(fail_silently=False)
+
+print(email.sendery_receipt["id"])
+```
+
+## Password resets
+
+Publish a `password-reset` template with `name` and `action_url`. Use `SenderyPasswordResetForm` with Django’s authentication views. Add these routes to your `urlpatterns` and provide Django’s standard password-reset HTML pages under `templates/registration/`. If the routes already exist, change only the reset view’s `form_class`.
+
+```python
+# urls.py
+from django.contrib.auth import views as auth_views
+from django.urls import path
+from sendery_django.forms import SenderyPasswordResetForm
+
+urlpatterns = [
+    path("password-reset/", auth_views.PasswordResetView.as_view(
+        form_class=SenderyPasswordResetForm,
+    ), name="password_reset"),
+    path("password-reset/done/", auth_views.PasswordResetDoneView.as_view(),
+         name="password_reset_done"),
+    path("reset/<uidb64>/<token>/", auth_views.PasswordResetConfirmView.as_view(),
+         name="password_reset_confirm"),
+    path("reset/done/", auth_views.PasswordResetCompleteView.as_view(),
+         name="password_reset_complete"),
+]
+```
+
+## Retry a send
+
+Keep `fail_silently=False` to receive [`SenderyError`](https://sendery.co/en/docs/python) on API failures. The backend makes one attempt. In a [background task](https://sendery.co/en/docs/queues), save the recipient, variables, and `idempotency_key` before sending and reuse them for retries.
+
+```python
+# Use the same saved recipient, variables, and event key on every attempt.
+email = TemplateEmail(
+    to="alex@example.com",
+    template="welcome",
+    data={"name": "Alex", "action_url": "https://example.com/start"},
+    idempotency_key="welcome-123",
+)
+email.send(fail_silently=False)
+```
+
+## More
+
+See [idempotency and retries](https://sendery.co/en/docs/idempotency) for retry conditions, delays, and reusing a key across attempts.
+
+## License
+
+[MIT](LICENSE).

sendery_django-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sendery-django"
+version = "0.1.0"
+description = "Sendery template email client for Django"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+dependencies = ["sendery>=0.1,<0.2", "Django>=5.2,<5.3"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[project.urls]
+Documentation = "https://sendery.co/en/docs/django"
+Repository = "https://github.com/sendery-co/sendery-django"

sendery_django-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sendery_django-0.1.0/src/sendery_django/__init__.py

@@ -0,0 +1,11 @@
+"""Sendery integration for Django."""
+from django.core.mail import EmailMessage
+import json
+import uuid
+
+
+class TemplateEmail(EmailMessage):
+    def __init__(self, *, to, template, data, locale=None, idempotency_key=None, **kwargs):
+        super().__init__(to=[to], **kwargs)
+        self.sendery_payload = json.loads(json.dumps({"template": template, "data": data, "locale": locale}, allow_nan=False))
+        self.sendery_key = idempotency_key if idempotency_key is not None else str(uuid.uuid4())

sendery_django-0.1.0/src/sendery_django/backend.py

@@ -0,0 +1,20 @@
+from django.conf import settings
+from django.core.mail.backends.base import BaseEmailBackend
+from sendery import Sendery, SenderyError
+from . import TemplateEmail
+
+
+class EmailBackend(BaseEmailBackend):
+    def send_messages(self, email_messages):
+        client = Sendery(settings.SENDERY_API_KEY, getattr(settings, "SENDERY_URL", "https://sendery.co"))
+        sent = 0
+        for message in email_messages or []:
+            if not isinstance(message, TemplateEmail) or len(message.to) != 1 or message.cc or message.bcc or message.attachments:
+                raise ValueError("Use TemplateEmail with exactly one recipient and no attachments.")
+            try:
+                message.sendery_receipt = client.send(to=message.to[0], **message.sendery_payload, idempotency_key=message.sendery_key)
+                sent += 1
+            except SenderyError:
+                if not self.fail_silently:
+                    raise
+        return sent

sendery_django-0.1.0/src/sendery_django/forms.py

@@ -0,0 +1,12 @@
+from django.contrib.auth.forms import PasswordResetForm
+from django.urls import reverse
+from . import TemplateEmail
+
+
+class SenderyPasswordResetForm(PasswordResetForm):
+    template_key = "password-reset"
+
+    def send_mail(self, subject_template_name, email_template_name, context, from_email, to_email, html_email_template_name=None):
+        path = reverse("password_reset_confirm", kwargs={"uidb64": context["uid"], "token": context["token"]})
+        url = f"{context['protocol']}://{context['domain']}{path}"
+        TemplateEmail(to=to_email, template=self.template_key, data={"name": context["user"].get_username(), "action_url": url}, from_email=from_email).send()

sendery_django-0.1.0/src/sendery_django.egg-info/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: sendery-django
+Version: 0.1.0
+Summary: Sendery template email client for Django
+License-Expression: MIT
+Project-URL: Documentation, https://sendery.co/en/docs/django
+Project-URL: Repository, https://github.com/sendery-co/sendery-django
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sendery<0.2,>=0.1
+Requires-Dist: Django<5.3,>=5.2
+Dynamic: license-file
+
+# Sendery for Django
+
+Send Sendery templates through Django’s email backend.
+
+[Documentation](https://sendery.co/en/docs/django) · [API reference](https://sendery.co/en/docs/send-email) · [Changelog](CHANGELOG.md)
+
+## Requirements
+
+Django 5.2 and Python 3.10+.
+
+## Install
+
+```bash
+pip install sendery-django
+```
+
+## Configure the backend
+
+Publish a `welcome` template with `name` and `action_url` variables, and create a [project API key](https://sendery.co/en/docs/authentication). Store it as `SENDERY_API_KEY` on your server. Add the backend and key to your Django settings.
+
+```python
+# settings.py
+import os
+
+EMAIL_BACKEND = "sendery_django.backend.EmailBackend"
+SENDERY_API_KEY = os.environ["SENDERY_API_KEY"]
+```
+
+## Send an email
+
+Use `TemplateEmail` with one recipient. Its `sendery_receipt` contains the accepted email’s ID and status. Ordinary `EmailMessage` objects, attachments, and `cc` or `bcc` recipients are not supported. Set the sender in your Sendery project.
+
+```python
+from sendery_django import TemplateEmail
+
+email = TemplateEmail(
+    to="alex@example.com",
+    template="welcome",
+    data={"name": "Alex", "action_url": "https://example.com/start"},
+)
+email.send(fail_silently=False)
+
+print(email.sendery_receipt["id"])
+```
+
+## Password resets
+
+Publish a `password-reset` template with `name` and `action_url`. Use `SenderyPasswordResetForm` with Django’s authentication views. Add these routes to your `urlpatterns` and provide Django’s standard password-reset HTML pages under `templates/registration/`. If the routes already exist, change only the reset view’s `form_class`.
+
+```python
+# urls.py
+from django.contrib.auth import views as auth_views
+from django.urls import path
+from sendery_django.forms import SenderyPasswordResetForm
+
+urlpatterns = [
+    path("password-reset/", auth_views.PasswordResetView.as_view(
+        form_class=SenderyPasswordResetForm,
+    ), name="password_reset"),
+    path("password-reset/done/", auth_views.PasswordResetDoneView.as_view(),
+         name="password_reset_done"),
+    path("reset/<uidb64>/<token>/", auth_views.PasswordResetConfirmView.as_view(),
+         name="password_reset_confirm"),
+    path("reset/done/", auth_views.PasswordResetCompleteView.as_view(),
+         name="password_reset_complete"),
+]
+```
+
+## Retry a send
+
+Keep `fail_silently=False` to receive [`SenderyError`](https://sendery.co/en/docs/python) on API failures. The backend makes one attempt. In a [background task](https://sendery.co/en/docs/queues), save the recipient, variables, and `idempotency_key` before sending and reuse them for retries.
+
+```python
+# Use the same saved recipient, variables, and event key on every attempt.
+email = TemplateEmail(
+    to="alex@example.com",
+    template="welcome",
+    data={"name": "Alex", "action_url": "https://example.com/start"},
+    idempotency_key="welcome-123",
+)
+email.send(fail_silently=False)
+```
+
+## More
+
+See [idempotency and retries](https://sendery.co/en/docs/idempotency) for retry conditions, delays, and reusing a key across attempts.
+
+## License
+
+[MIT](LICENSE).

sendery_django-0.1.0/src/sendery_django.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+src/sendery_django/__init__.py
+src/sendery_django/backend.py
+src/sendery_django/forms.py
+src/sendery_django.egg-info/PKG-INFO
+src/sendery_django.egg-info/SOURCES.txt
+src/sendery_django.egg-info/dependency_links.txt
+src/sendery_django.egg-info/requires.txt
+src/sendery_django.egg-info/top_level.txt
+tests/test_backend.py

sendery_django-0.1.0/src/sendery_django.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sendery_django-0.1.0/src/sendery_django.egg-info/requires.txt

@@ -0,0 +1,2 @@
+sendery<0.2,>=0.1
+Django<5.3,>=5.2

sendery_django-0.1.0/src/sendery_django.egg-info/top_level.txt

@@ -0,0 +1 @@
+sendery_django

sendery_django-0.1.0/tests/test_backend.py

@@ -0,0 +1,46 @@
+import pickle
+import unittest
+from unittest.mock import patch
+from django.conf import settings
+if not settings.configured:
+    settings.configure(SECRET_KEY="test-only", ROOT_URLCONF=__name__, INSTALLED_APPS=["django.contrib.auth", "django.contrib.contenttypes"], SENDERY_API_KEY="test", EMAIL_BACKEND="sendery_django.backend.EmailBackend", DEFAULT_FROM_EMAIL="hello@example.com")
+import django
+django.setup()
+from django.urls import path
+from django.http import HttpResponse
+urlpatterns = [path("reset/<uidb64>/<token>/", lambda request, **kwargs: HttpResponse(), name="password_reset_confirm")]
+from django.core.mail import EmailMessage
+from sendery_django import TemplateEmail
+from sendery_django.backend import EmailBackend
+
+
+class BackendTests(unittest.TestCase):
+    def test_queue_serialization_preserves_key_and_data(self):
+        data = {"name": "Original"}
+        email = TemplateEmail(to="alex@example.com", template="welcome", data=data)
+        data["name"] = "Changed"
+        restored = pickle.loads(pickle.dumps(email))
+        with patch("sendery_django.backend.Sendery") as client:
+            self.assertEqual(1, EmailBackend().send_messages([restored]))
+            payload = client.return_value.send.call_args.kwargs
+        self.assertEqual(email.sendery_key, payload["idempotency_key"])
+        self.assertEqual("Original", payload["data"]["name"])
+
+    def test_rejects_ordinary_emails_and_multiple_recipients(self):
+        with self.assertRaises(ValueError):
+            EmailBackend().send_messages([EmailMessage("subject", "body", to=["a@example.com"])])
+        email = TemplateEmail(to="a@example.com", template="welcome", data={})
+        email.to.append("b@example.com")
+        with self.assertRaises(ValueError):
+            EmailBackend().send_messages([email])
+
+    def test_password_reset_keeps_django_token_and_url(self):
+        from sendery_django.forms import SenderyPasswordResetForm
+        from types import SimpleNamespace
+        user = SimpleNamespace(get_username=lambda: "Alex")
+        context = {"uid": "MTI", "token": "signed-token", "protocol": "https", "domain": "product.example", "user": user}
+        with patch("sendery_django.forms.TemplateEmail") as message:
+            SenderyPasswordResetForm().send_mail("subject", "body", context, "hello@example.com", "alex@example.com")
+        self.assertEqual("https://product.example/reset/MTI/signed-token/", message.call_args.kwargs["data"]["action_url"])
+        self.assertEqual("password-reset", message.call_args.kwargs["template"])
+        message.return_value.send.assert_called_once()