{
    "info": {
        "author": "Bradley Whittington",
        "author_email": "radbrad182@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Framework :: Django",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Topic :: Software Development :: Libraries :: Python Modules"
        ],
        "description": "==============================\nDjango-Templated-Email\n==============================\n:Info: A Django oriented templated email sending class\n:Author: Bradley Whittington (http://github.com/bradwhittington, http://twitter.com/darb)\n:Tests: .. image:: https://api.travis-ci.org/bradwhittington/django-templated-email.png\n\nOverview\n=================\ndjango-templated-email is oriented towards sending templated emails \nintended for use with transactional mailers (with support for MailchimpSTS, \nand PostageApp), but as a default with a backend class which uses django's \ntemplating system, and django's core.mail functions. The library supports \ntemplate inheritence, adding cc'd and bcc'd recipients, configurable \ntemplate naming and location, with easy switching between backends/providers.\n\nThe send_templated_email method can be thought of as the render_to_response\nshortcut for email.\n\nGetting going - installation\n==============================\n\nInstalling::\n\n    pip install django-templated-email\n\nYou can add the following to your settings.py (but it works out the box)::\n\n    TEMPLATED_EMAIL_BACKEND = 'templated_email.backends.vanilla_django.TemplateBackend'\n\n    # You can use a shortcut version\n    TEMPLATED_EMAIL_BACKEND = 'templated_email.backends.vanilla_django'\n\n    # You can also use a class directly\n    from templated_email.backends.vanilla_django import TemplateBackend\n    TEMPLATED_EMAIL_BACKEND = TemplateBackend \n\n\nSending templated emails\n==============================\n\nExample usage using vanilla_django TemplateBackend backend\n\nPython to send mail::\n\n    from templated_email import send_templated_mail\n    send_templated_mail(\n            template_name='welcome',\n            from_email='from@example.com',\n            recipient_list=['to@example.com'],\n            context={\n                'username':request.user.username,\n                'full_name':request.user.get_full_name(),\n                'signup_date':request.user.date_joined\n            },\n            # Optional:\n            # cc=['cc@example.com'],\n            # bcc=['bcc@example.com'],\n            # headers={'My-Custom-Header':'Custom Value'},\n            # template_prefix=\"my_emails/\",\n            # template_suffix=\"email\",\n    )\n\nIf you would like finer control on sending the email, you can use **get_templated_email**, which will return a django **EmailMessage** object, prepared using the **vanilla_django** backend::\n\n    from templated_email import get_templated_mail\n    get_templated_mail(\n            template_name='welcome',\n            from_email='from@example.com',\n            to=['to@example.com'],\n            context={\n                'username':request.user.username,\n                'full_name':request.user.get_full_name(),\n                'signup_date':request.user.date_joined\n            },\n            # Optional:\n            # cc=['cc@example.com'],\n            # bcc=['bcc@example.com'],\n            # headers={'My-Custom-Header':'Custom Value'},\n            # template_prefix=\"my_emails/\",\n            # template_suffix=\"email\",\n    )\n\nYou can also **cc** and **bcc** recipients using **cc=['example@example.com']**. Some backends have other parameters you can override, see below.\n\nYour template\n-------------\n\nThe templated_email/ directory needs to be the templates directory.\n\nThe backend will look in *my_app/templates/templated_email/welcome.email* ::\n\n    {% block subject %}My subject for {{username}}{% endblock %}\n    {% block plain %}\n      Hi {{full_name}}, \n\n      You just signed up for my website, using:\n          username: {{username}}\n          join date: {{signup_date}}\n\n      Thanks, you rock!\n    {% endblock %}\n\nIf you want to include an HTML part to your emails, simply use the 'html' block ::\n\n    {% block html %}\n      <p>Hi {{full_name}},</p>\n\n      <p>You just signed up for my website, using:\n          <dl>\n            <dt>username</dt><dd>{{username}}</dd>\n            <dt>join date</dt><dd>{{signup_date}}</dd>\n          </dl>\n      </p>\n\n      <p>Thanks, you rock!</p>\n    {% endblock %}\n\nThe plain part can also be calculated from the HTML using `html2text <https://pypi.python.org/pypi/html2text>`_. If you don't specify the plain block and `html2text <https://pypi.python.org/pypi/html2text>`_ package is installed, the plain part will be calculated from the HTML part. You can disable this behaviour in settings.py ::\n\n    TEMPLATED_EMAIL_AUTO_PLAIN = False\n\nYou can globally override the template dir, and file extension using the following variables in settings.py ::\n\n    TEMPLATED_EMAIL_TEMPLATE_DIR = 'templated_email/' #use '' for top level template dir, ensure there is a trailing slash\n    TEMPLATED_EMAIL_FILE_EXTENSION = 'email'\n\nFor the **vanilla_django** and **mailchimp_sts** backends you can set a value for **template_prefix** and **template_suffix** (or use the less backend-portable **template_dir** / **file_extension**) for every time you call **send_templated_mail**, if you wish to store a set of templates in a different directory. Remember to include a trailing slash.\n\nPlease note / Warning about template inheritence\n------------------------------------------------\nThere is very basic support for template inheritence (using **{% extends ... %}** in templates). You will run into issues if you use **{{block.super}}**, and will result in blank parts of emails.\n\nLegacy Behaviour\n----------------\n\nThe 0.2.x version of the library looked in django template directories/loaders \nfor **templated_email/welcome.txt** ::\n\n    Hey {{full_name}},\n\n    You just signed up for my website, using:\n        username: {{username}}\n        join date: {{signup_date}}\n\n    Thanks, you rock!\n\nIt will use **templated_email/welcome.html** for the html part \nof the email allowing you to make it so much pretty. \n\nFuture Plans\n------------\n\nSee https://github.com/bradwhittington/django-templated-email/issues?state=open\n\nUsing django_templated_email in 3rd party applications\n=======================================================\n\nIf you would like to use django_templated_email to handle mail in a reusable application, you should note that:\n\n* Your calls to **send_templated_mail** should set a value for **template_dir**, so you can keep copies of your app-specific templates local to your app (although the loader will find your email templates if you store them in *<your app>/templates/templated_email*, if **TEMPLATED_EMAIL_TEMPLATE_DIR** has not been overidden)\n* If you do (and you should) set a value for **template_dir**, remember to include a trailing slash, i.e. *'my_app_email/'*\n* The deployed app may use a different backend which doesn't use the django templating backend, and as such make a note in your README warning developers that if they are using django_templated_email already, with a different backend, they will need to ensure their email provider can send all your templates (ideally enumerate those somewhere convenient)\n\nNotes on specific backends\n==============================\n\nUsing vanilla_django\n--------------------------\n\nThis is the default backend, and as such requires no special configuration, and will work out of the box. By default it assumes the following settings (should you wish to override them)::\n\n    TEMPLATED_EMAIL_TEMPLATE_DIR = 'templated_email/' #Use '' for top level template dir\n    TEMPLATED_EMAIL_FILE_EXTENSION = 'email'\n\nFor legacy purposes you can specify email subjects in your settings file (but, the preferred method is to use a **{% block subject %}** in your template)::\n\n    TEMPLATED_EMAIL_DJANGO_SUBJECTS = {\n        'welcome':'Welcome to my website',\n    }\n\nAdditionally you can call **send_templated_mail** and optionally override the following parameters::\n\n    template_prefix='your_template_dir/'  # Override where the method looks for email templates (alternatively, use template_dir)\n    template_suffix='email'               # Override the file extension of the email templates (alternatively, use file_extension)\n    cc=['fubar@example.com']              # Set a CC on the mail\n    bcc=['fubar@example.com']             # Set a BCC on the mail\n    template_dir='your_template_dir/'     # Override where the method looks for email templates\n    connection=your_connection            # Takes a django mail backend connection, created using **django.core.mail.get_connection**\n    auth_user='username'                  # Override the user that the django mail backend uses, per **django.core.mail.send_mail**\n    auth_password='password'              # Override the password that the django mail backend uses, per **django.core.mail.send_mail**\n\nUsing PostageApp\n--------------------------\n\nTo use the PostageApp (http://postageapp.com) send method, you will need to install python-postageapp::\n\n    pip install -e git://github.com/bradwhittington/python-postageapp.git#egg=postageapp\n\nAnd add the following to your settings.py::\n\n    TEMPLATED_EMAIL_BACKEND = 'templated_email.backends.postageapp_backend.TemplateBackend'\n\n    POSTAGEAPP_API_KEY = 'yourapikey'\n\n    #If you are already using django-postageapp:\n\n    EMAIL_POSTAGEAPP_API_KEY = POSTAGEAPP_API_KEY\n\nUsing MAILCHIMP STS\n--------------------------\n\nTo use the MailChimp STS send method, you will need to install mailsnake (please note, until the main mailsnake has STS support, you need to use my fork)::\n\n    pip install -e git://github.com/nitinhayaran/greatape.git#egg=greatape\n\nAnd add the following to your settings.py::\n\n    TEMPLATED_EMAIL_BACKEND = 'templated_email.backends.mailchimp_sts.TemplateBackend'\n\n    MAILCHIMP_API_KEY = 'yourapikey'\n\n    # For the django back-end specifically\n    TEMPLATED_EMAIL_MAILCHIMP = {\n        'welcome':{\n          'subject':'Welcome to my website',\n          'track_opens':True,\n          'track_clicks':False,\n          'tags':['my','little','pony'],\n        }\n    }\n\nThe Mailchimp STS sender uses the same template processor as the VanillaDjango backend, so you can override the following settings globally::\n    \n    TEMPLATED_EMAIL_TEMPLATE_DIR = 'templated_email/' #use '' for top level template dir\n    TEMPLATED_EMAIL_FILE_EXTENSION = 'email'\n\nYou can also override the *template_dir* variable when calling *send_templated_mail*\n\n.. _Django: http://djangoproject.com",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/vintasoftware/django-templated-email",
        "keywords": null,
        "license": "MIT",
        "maintainer": null,
        "maintainer_email": null,
        "name": "vinta-django-templated-email",
        "package_url": "https://pypi.org/project/vinta-django-templated-email/",
        "platform": "any",
        "project_url": "https://pypi.org/project/vinta-django-templated-email/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/vintasoftware/django-templated-email"
        },
        "release_url": "https://pypi.org/project/vinta-django-templated-email/0.5/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "A Django oriented templated / transaction email abstraction",
        "version": "0.5"
    },
    "last_serial": 2157546,
    "releases": {
        "0.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "79a314a86249ed201cf08440c868b0d9",
                    "sha256": "acdc19838bf49b168e1e11f482812ebe0e1860b7ce730af359bce3a0e2114cb0"
                },
                "downloads": -1,
                "filename": "vinta-django-templated-email-0.5.tar.gz",
                "has_sig": false,
                "md5_digest": "79a314a86249ed201cf08440c868b0d9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12947,
                "upload_time": "2016-06-08T20:02:49",
                "url": "https://files.pythonhosted.org/packages/9e/53/1cf7ebe13350a728be6b0a545ba0f8fa513f014f593d4f2344e6e8f27d1d/vinta-django-templated-email-0.5.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "79a314a86249ed201cf08440c868b0d9",
                "sha256": "acdc19838bf49b168e1e11f482812ebe0e1860b7ce730af359bce3a0e2114cb0"
            },
            "downloads": -1,
            "filename": "vinta-django-templated-email-0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "79a314a86249ed201cf08440c868b0d9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 12947,
            "upload_time": "2016-06-08T20:02:49",
            "url": "https://files.pythonhosted.org/packages/9e/53/1cf7ebe13350a728be6b0a545ba0f8fa513f014f593d4f2344e6e8f27d1d/vinta-django-templated-email-0.5.tar.gz"
        }
    ]
}