Giter Club home page Giter Club logo

django-email-tools's Introduction

Django Email Tools

CircleCI Coverage Status PyPi Package

Requirements

  • Python 3.6+
  • Django 2.2+

Installation

Install with pip pip install django-email-tools

Add email_tools to INSTALLED_APPS

INSTALLED_APPS = (
    ...
    'email_tools.apps.EmailToolsConfig',
    ...
)

Add something like the following to urls.py

if settings.DEBUG:
    urlpatterns = [
        path("emailpreview/", include("email_tools.urls", namespace="email_tools")),
    ] + urlpatterns

Documentation

All settings are handled within a EMAIL_TOOLS dictionary.

Example:

EMAIL_TOOLS = {
    'FROM_EMAIL': '[email protected]',
    'TEMPLATE_DIRECTORY': os.path.join(settings.BASE_DIR, "templates", "emails"),
}

The available settings are:

FROM_EMAIL the email to send from.

TEMPLATE_DIRECTORY the path to a directory containing .html files used in emails.

Usage

Django Email Tools contains two main parts.

First, is email_tools.emails.send_email a utility to send html emails given a django template and context.

The second is a debugging page that allows you to see what the rendered result of an email template would look like. This page also allows you to get a list of variables used by the template and modify those variables and see results in real-time.

Changelog

See CHANGELOG.md

License

See LICENSE

django-email-tools's People

Contributors

armaant avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.