Skip to main content

A reusable Django application and EmailBackend that allows email configuration to be changed while the server is running.

Project description

image1 image2 image3

A reusable Django application, admin panel, and EmailBackend that allows email configuration to be changed while the server is running. The goal of the project is to be the absolute easiest way to get email configured across multiple environments.

image4

Quickstart

  • Install Django Dynamic Email Settings:

    $ pip install django-des
  • Add it to your `INSTALLED_APPS`:

    INSTALLED_APPS = (
        ...
        'django_des',
        ...
    )
  • Add the dynamic email configuration email backend to settings.py

    EMAIL_BACKEND = 'django_des.backends.ConfiguredEmailBackend'
  • To enable test email support, add Django DES’s URL patterns:

    from django_des import urls as django_des_urls
    
    
    urlpatterns = [
        ...
        url(r'^django-des/', include(django_des_urls)),
    ]

Settings

  • DES_TEST_SUBJECT: Set to override the default test email subject line. (Default: "Test Email")

    Example:

    DES_TEST_SUBJECT = "My New Subject"
  • DES_TEST_TEXT_TEMPLATE: Set to override the template used for text test emails. Note that this is a template file location, not a template string. (Default: "des/test_email.txt")

    Example:

    DES_TEST_TEXT_TEMPLATE = "myapp/email/test_email.txt"
  • DES_TEST_HTML_TEMPLATE: Set to enable HTML emails and use the template provided as the text/html content. (Default: None)

    Example:

    DES_TEST_HTML_TEMPLATE = "myapp/email/test_email.html"

Features

  • Configure email on the fly, no need to restart the server

  • Send test emails from the Django Admin panel

  • Test text and HTML email sending

  • Supports third party mail packages like django-mailer

Support

Python

  • 2.7

  • 3.4

  • 3.5

  • 3.6

Django

  • 1.8

  • 1.9

  • 1.10

  • 1.11

  • 2.0

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements_dev.txt
(myenv) $ pip install -r requirements_test.txt
(myenv) $ tox

Credits

Tools used in rendering this package:

History

0.1.0 (2017-12-06)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-des-1.0.0.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

django_des-1.0.0-py2.py3-none-any.whl (12.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file django-des-1.0.0.tar.gz.

File metadata

  • Download URL: django-des-1.0.0.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for django-des-1.0.0.tar.gz
Algorithm Hash digest
SHA256 5a59f5e3647be7761fc15f11352d2229d8697e8bba856a33a9a9a9c855a83d78
MD5 9a94e67b5a673e9db3bb58eddd2ef97f
BLAKE2b-256 fbb309ccf9b898f3bf75687e0af1cdad11217225d7fbd8e27a70ff35cd804e39

See more details on using hashes here.

File details

Details for the file django_des-1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_des-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 eb53bf14a9d638755437995c1678b2e739832cfa1964175b88fbfbf4e336c126
MD5 195623dbbc40d5c4d0f3ca8a9aa752c2
BLAKE2b-256 986c69a7a989e79d65b3579bce7df2e6754a98512da35bf3629387979921db5d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page