Files
django-anymail/README.rst
Chris Jones 474f628fd9 moar docs.
2012-02-28 15:53:29 -08:00

45 lines
944 B
ReStructuredText

Djrill, for Mandrill
====================
Djrill is an email backend and new message class for Django users that want to take advantage of the Mandrill transactional email
service from MailChimp.
Dependencies
------------
The only dependency other than Django is the ``requests`` library from Kenneth Reitz. If you do not
install through PyPI you will need to do ::
pip install requests
Installation
------------
``pip install djrill``
Configuration
-------------
In ``settings.py``:
1. Add ``djrill`` to your ``INSTALLED_APPS``. ::
INSTALLED_APPS = (
...
"djrill"
)
2. Add the following two lines, substituting your own ``MANDRILL_API_KEY``::
MANDRILL_API_KEY = "brack3t-is-awesome"
MANDRILL_API_URL = "http://mandrillapp.com/api/1.0"
3. Override your existing email backend with the following line::
EMAIL_BACKEND = "djrill.mail.backends.djrill.DjrillBackend"
Usage
-----
Coming soon