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-2.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c9e7b0cf535cc3dd9a051396d8b3e24b444f07df55c464b1c4d5f126b32d0b4 |
|
MD5 | d7c613b241ca7071a6db1d6aabb352a4 |
|
BLAKE2b-256 | f5c124a03e5d633ed86533558f89d1f722830d92574bdf4726e5b9173adb8dbb |
Hashes for django_ses_sns_tracker-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3044417edc1892c5a843f2e4973d7b939902ec747e08abd6c4fd169d1bda8281 |
|
MD5 | 46f5a701938a5e070233de14f924d39b |
|
BLAKE2b-256 | ccb42b41fd433c380bbdca566ce68547b67d3259797e92544dc8baefc283e37b |