From 5c10c39157df6e104039c7032bcd7e29b6bcd199 Mon Sep 17 00:00:00 2001 From: Marc Aymerich Date: Thu, 7 May 2015 20:04:28 +0000 Subject: [PATCH] Added mailer README file --- orchestra/contrib/mailer/README.md | 5 +++++ orchestra/contrib/tasks/README.md | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 orchestra/contrib/mailer/README.md diff --git a/orchestra/contrib/mailer/README.md b/orchestra/contrib/mailer/README.md new file mode 100644 index 00000000..8c442f35 --- /dev/null +++ b/orchestra/contrib/mailer/README.md @@ -0,0 +1,5 @@ +This is a simlified clone of [django-mailer](https://github.com/pinax/django-mailer). + +Using `orchestra.contrib.mailer.backends.EmailBackend` as your email backend will have the following effects: + * E-mails sent with Django's `send_mass_mail()` will be queued and sent by an out-of-band perioic task. + * E-mails sent with Django's `send_mail()` will be sent right away by an asynchronous background task. diff --git a/orchestra/contrib/tasks/README.md b/orchestra/contrib/tasks/README.md index e1994326..7b7689b2 100644 --- a/orchestra/contrib/tasks/README.md +++ b/orchestra/contrib/tasks/README.md @@ -1,5 +1,5 @@ This is a wrapper around djcelery and celery `@task` and `@periodic_task` decorators. It provides transparent support for switching between executing a task on a plain Python thread or -pushing the task on a queue (rabbitmq) and executing it on a Celery worker. +the traditional way of pushing the task on a queue (rabbitmq) and wait for a Celery worker to run it. A queueless threaded execution has the advantage of 0 moving parts instead of the alternative rabbitmq and celery workers. Less dependencies, less memory footprint, less points of failure.