Email async notifications with celery.
Project description
Async notifications
Email notification with celery and administrative view for send email with delay e.g daily
Features
Celery integration
Administrative view
Enqueued mail system and instantly send
Problems notification
User filter email
Template system with template context
Send to User, Group or external email
Django cms integration (djcms_async_notifications) and standalone.
Custom text area widget support
Allow send group mail list if it’s defined.
Installation
Install from pip
$ pip install async_notificationsAdd required apps in your settings **
INSTALLED_APPS = [ ... 'ajax_select', 'async_notifications' ]Add ajax_select urls in urls.py
from django.conf.urls import url, include from ajax_select import urls as ajax_select_urls urlpatterns = [ ... url(r'^ajax_select/', include(ajax_select_urls)), ]It’s really important set CELERY_MODULE pointing to your project celery file, because it’s needed for assing task to the current project, and configure some default celery options
# settings.py CELERY_MODULE = "demo.celery" CELERY_TIMEZONE = TIME_ZONE CELERY_ACCEPT_CONTENT = ['pickle', 'json']Configure your email settings, e.g for development
DEFAULT_FROM_EMAIL="mail@example.com" EMAIL_HOST="localhost" EMAIL_PORT="1025"
# Copy celery app in your project folder from demo, and adjust the crontab execution
# celery.py app.conf.CELERYBEAT_SCHEDULE = { # execute 12:30 pm 'send_daily_emails': { 'task': 'async_notifications.tasks.send_daily', 'schedule': crontab(minute=30, hour=0), }, }
Remember use demo/__init__.py to update your projectfolder/__init__.py.
Run migrations
$ python manage.py migrate
Runing the project
You need to run 3 subsystems for run this app so you need 3 xterm, for this explanation I will use the demo project
Run smtp debug client
$ python -m smtpd -n -c DebuggingServer localhost:1025Run celery, if you aren’t setup celery yet see celery documentation.
$ celery -A demo worker -l info -BRun django
$ python manage.py runserver
Usage
Report your context template
from async_notifications.register import update_template_context
context = [
('fieldname', 'Field description'),
('fieldname2', 'Field description'),
...
]
update_template_context("yourcode", 'your email subject', context )This automátically create a Email template if not found.
Context is list of tuples with the fields available in the template context, this context is add in the same file that have send_email_from_template
Using with django templates
update_template_context("yourcode", 'your email subject', context, 'templatepath.html', as_template=True )Send dict as context is now available, but remember that you can not repit keys in dict so use with precaution.
Send an email :)
send_email_from_template(code, recipient,
context={},
enqueued=True,
user=None,
upfile=None)Params description:
recipient is a list of emails
code is the same code register in update_template_context
enqueued if False send the email immediately else enqueued to be sended when send email task run.
user user how send email
upfile attached file in email
Other optional options
Adding context dummy object
When you need to pass a default template message base on template, but you have not the template object and also you need to write the object with django template sintaxis you can use DummyContextObject that return always something like {{ myobj.attr1.objattr }}
from async_notifications.register import update_template_context, DummyContextObject
context = [
('myobj', 'Field description'),
...
]
message = render_to_string('some/template.html',
context={
'myobj': DummyContextObject('myobj')
}
)
update_template_context("yourcode", 'your email subject', context, message=message )Django cms integration
This configuration could help you to integrate with Django CMS.
include in your INSTALLED_APPS:
INSTALLED_APPS = [
...
'async_notifications',
'async_notifications.djcms_async_notifications',
]Configure how models and field async_notifications will use, ej. aldryn_people
ASYNC_NOTIFICATION_GROUP = 'aldryn_people.Group'
ASYNC_NOTIFICATION_GROUP_LOOKUP_FIELDS = {
'order_by': 'translations__name',
'email': 'email',
'group_lookup': 'translations__name',
'display': 'name',
'filter': ['translations__name__icontains']}
ASYNC_NOTIFICATION_USER = 'aldryn_people.Person'
ASYNC_NOTIFICATION_USER_LOOKUP_FIELDS = {
'order_by': 'translations__name',
'display': 'name',
'filter': [
'user__first_name__icontains',
'user__last_name__icontains',
'translations__name__icontains'],
'group_lookup': 'groups__translations__name'}cmsplugin-contact-plus
CONTACT_PLUS_SEND_METHOD = ‘async_notifications.djcms_async_notifications.contact_plus.send_email’ ASYNC_NOTIFICATION_CONTACT_PLUS_EMAIL = ‘email’
Default text area widget
For example using ckeditor widget
ASYNC_NOTIFICATION_TEXT_AREA_WIDGET = ‘ckeditor.widgets.CKEditorWidget’
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
File details
Details for the file async_notifications-0.1.14.tar.gz.
File metadata
- Download URL: async_notifications-0.1.14.tar.gz
- Upload date:
- Size: 27.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 118353b7bd269121140721318a07ea4e4b981fcdca0a4c83a27f692a430565a1 |
|
| MD5 | 1251198c3ba4388041478b7c9ff1ecef |
|
| BLAKE2b-256 | fe34866701ee8849f1527ebc4b1d5142e4e7f1f585d38d32862b555f4f918e28 |
