Django MarkDown Mail
Project description
# Django MarkDown Mail
[![PyPI version](https://badge.fury.io/py/dmdm.svg)](https://pypi.org/project/dmdm)
[![Build Status](https://travis-ci.org/nim65s/dmdm.svg?branch=master)](https://travis-ci.org/nim65s/dmdm)
[![Coverage Status](https://coveralls.io/repos/github/nim65s/dmdm/badge.svg?branch=master)](https://coveralls.io/github/nim65s/dmdm?branch=master)
[![Maintainability](https://api.codeclimate.com/v1/badges/6737a84239590ddc0d1e/maintainability)](https://codeclimate.com/github/nim65s/dmdm/maintainability)
Write your email in markdown, and send them in txt & html.
## Requirements
- Python 3.4+
- Django 2.0+
- [yejianye/mdmail](https://github.com/yejianye/mdmail)
## Install
`pip install dmdm`
## Usage
This replaces django's `django.core.email.send_mail`, but the mail will have an html alternative rendered from the text
part with markdown. You can also provide a custon `css` and even images (that will be inlined) located in `image_root`.
If you want to write your markdown in a template, just put the name of the template in `message` and add a `context`
(which can be `{}`) and eventually a `request`.
```python
send_mail(subject, message, from_email, recipient_list, context=None, request=None, fail_silently=False, css=None,
image_root='.', auth_user=None, auth_password=None, connection=None)
```
[![PyPI version](https://badge.fury.io/py/dmdm.svg)](https://pypi.org/project/dmdm)
[![Build Status](https://travis-ci.org/nim65s/dmdm.svg?branch=master)](https://travis-ci.org/nim65s/dmdm)
[![Coverage Status](https://coveralls.io/repos/github/nim65s/dmdm/badge.svg?branch=master)](https://coveralls.io/github/nim65s/dmdm?branch=master)
[![Maintainability](https://api.codeclimate.com/v1/badges/6737a84239590ddc0d1e/maintainability)](https://codeclimate.com/github/nim65s/dmdm/maintainability)
Write your email in markdown, and send them in txt & html.
## Requirements
- Python 3.4+
- Django 2.0+
- [yejianye/mdmail](https://github.com/yejianye/mdmail)
## Install
`pip install dmdm`
## Usage
This replaces django's `django.core.email.send_mail`, but the mail will have an html alternative rendered from the text
part with markdown. You can also provide a custon `css` and even images (that will be inlined) located in `image_root`.
If you want to write your markdown in a template, just put the name of the template in `message` and add a `context`
(which can be `{}`) and eventually a `request`.
```python
send_mail(subject, message, from_email, recipient_list, context=None, request=None, fail_silently=False, css=None,
image_root='.', auth_user=None, auth_password=None, connection=None)
```
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
dmdm-1.0.2.tar.gz
(4.3 kB
view hashes)
Built Distribution
dmdm-1.0.2-py3-none-any.whl
(6.2 kB
view hashes)