Simple wrapper around django-ses to receive and persist sns event data
Project description
django-ses-sns-tracker
A simple wrapper around django-ses to receive and persist sns event data.
Records mail delivery in the SESMailDelivery
model and updates the state if a matching SNS notification is received.
Requirements
- Django version 2.2+
- A PostgreSQL Database
Quick start
-
Add
ses_sns_tracker
to your INSTALLED_APPS setting like this:INSTALLED_APPS = [ # ... 'ses_sns_tracker', ]
-
Run
python manage.py migrate
to create the models. -
Setup
django-ses
-
Add the webhook view to
urls.py
(useSESSNSTrackerWebhookView
instead ofSESEventWebhookView
fromdjango_ses
):from ses_sns_tracker.views import SESSNSTrackerWebhookView urlpatterns = [ # ... path('ses-events/', SESSNSTrackerWebhookView.as_view(), name='handle-event-webhook'), # ... ]
-
(Optional) Use
ses_sns_tracker.backends.SESSNSTrackerBackend
as your default email backend:EMAIL_BACKEND = 'ses_sns_tracker.backends.SESSNSTrackerBackend'
This way all emails will be send via the Amazon SES API.
-
(Optional) Send an email via the
SESMailDelivery
manager (doesn't requireSESSNSTrackerBackend
as the default mail backend):from django.core.mail import EmailMessage from ses_sns_tracker.models import SESMailDelivery message = EmailMessage( subject='email subject', body='email body', from_email='sender@example.com', to=['recipient@example.com'], ) SESMailDelivery.objects.create_message(message, fail_silently=False, fake_delivery=False)
Settings
-
SES_SNS_TRACKER_DEBUG_BACKEND = 'django.core.mail.backends.console.EmailBackend'
Set mail backend to use for the actual mail delivery in
DEBUG
mode (SESMailDelivery
objects will still be created). Default:None
-
SES_SNS_TRACKER_USE_CRYPTOGRAPHY = True
Use
crypthography
instead ofM2Crypto
to verify the signature of messages received from SNS. Default:True
Development setup
-
Upgrade packaging tools:
pip install --upgrade pip setuptools wheel
-
Install packages from
requirements-dev.txt
:pip install -r requirements-dev.txt
-
(Optional) Override settings in
example_proj/settings_local.py
&tests/settings_local.py
as required.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-ses-sns-tracker-3.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5be819183c2bbbab9309b1f8f93ca041c952e0167922b44de69424128ae09fe6 |
|
MD5 | 24bf356b20646936684f465415ad7574 |
|
BLAKE2b-256 | 1f9e9d2ce92470ce9b6350fde06c7051050d551712f371690133f5703027bcc5 |
Hashes for django_ses_sns_tracker-3.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c96d95468d0f8a0859254f4a78121f2819a99c66fb991764f64b30103b4ce2af |
|
MD5 | 88f3ee2fe16d40b5378379ab7644aa78 |
|
BLAKE2b-256 | 8c5a791188a6149c12e54423fc462191d2b665c833e98edaf15bf001609ca63a |