django-lime 0.2

Mixed content e-mails for Django made simple.

Package

django-lime

Description

Easy sending of mixed content (html + plain) emails for Django.

Installation

1. Install in your virtual environment:

   $ pip install django-lime

2. Add lime to your INSTALLED_APPS of your Django settings module:

   >>> INSTALLED_APPS = (
   >>>     # ...
   >>>     'lime',
   >>>     # ...
   >>> )
   

3. Copy the templates from lime to your main templates directory.

4. Define LIME_SITE_LOGO and LIME_SITE_TEAM variables in your settings module.

5. Make sure your django.contrib.sites.sites.models.Site has data that makes sense, as site_name and domain values will be taken from there. Alternatively, you can define (override) those by defining the following variables in your settings module.

   • LIME_SITE_NAME
   • LIME_SITE_DOMAIN

Usage examples

Inherit your app templates from lime base templates or your own copy of the lime templates (copied to templates directory). By default the following parameters are passed to your template:

• site_name: Taken from your django.contrib.sites.models.Site.
• domain: Taken from your django.contrib.sites.models.Site
• site_team: Site team name.
• site_logo: Relative URL to site logo.

>>> from lime import send_email
>>>
>>> send_email(
>>>     _("You've got mail"),
>>>     'ramzes.4@example.come', # From
>>>     'someone.else@example.com', # To
>>>     {
>>>         'date_submitted': datetime.datetime.now().strftime("%Y-%m-%dT%H:%M:%S"),
>>>         'url': 'http://example.com/check-this-fantastic-link.html',
>>>         'full_name': 'John Doe',
>>>         'from_name': 'Ramzes the 4th',
>>>     },
>>>     'foo/emails/foo_test.txt', # Text template
>>>     'foo/emails/foo_test.html' # HTML tempalte
>>> )

For a working example (including set-up Django environment) check the https://bitbucket.org/barseghyanartur/django-lime (example directory).

License

GPL 2.0/LGPL 2.1

Support

For any issues contact me at the e-mail given in the Author section.

Author

Artur Barseghyan <artur.barseghyan@gmail.com>