Metadata-Version: 2.1
Name: django-epfl-mail
Version: 0.0.2
Summary: A Django application with templates for emails.
Home-page: https://github.com/epfl-si/django-epfl-mail
Author: William Belle
Author-email: william.belle@gmail.com
License: UNKNOWN
Project-URL: Changelog, https://github.com/epfl-si/django-epfl-mail/blob/main/CHANGELOG.md
Project-URL: Source, https://github.com/epfl-si/django-epfl-mail
Project-URL: Tracker, https://github.com/epfl-si/django-epfl-mail/issues
Description: django-epfl-mail
        ================
        
        [![Build Status][github-actions-image]][github-actions-url]
        [![Coverage Status][codecov-image]][codecov-url]
        [![PyPI version][pypi-image]][pypi-url]
        [![PyPI Python version][pypi-python-image]][pypi-url]
        
        A Django application with templates for emails.
        
        Requirements
        ------------
        
        - Python 2.7, 3.5 or later
        - Django 1.11, 2.2
        
        Installation
        ------------
        
        Installing from PyPI is as easy as doing:
        
        ```bash
        pip install django-epfl-mail
        ```
        
        Documentation
        -------------
        
        ### Setup
        
        Add `'django_epflmail'` to your `INSTALLED_APPS` setting.
        
        ```python
        INSTALLED_APPS = [
            ...
            'django_epflmail',
        ]
        ```
        
        ### Example template
        
        ```python
        from django.core.mail.message import EmailMessage
        from django.template.loader import render_to_string
        
        html = render_to_string("example.html", {"APP_TITLE": "Example"})
        email = EmailMessage(
            "Email Example", html, "from@example.com", ["to@example.com"]
        )
        email.send()
        ```
        
        ```htmldjango
        {% extends "epflmail/default.html" %}
        {% load i18n %}
        
        {% block title %}
        Email Example
        {% endblock %}
        
        {% block online %}
          {% with ONLINE_VERSION_LINK="https://example.com" %}
            {% include 'epflmail/includes/online.inc.html'%}
          {% endwith %}
        {% endblock %}
        
        {% block main %}
          <p>This is an example.</p>
        {% endblock %}
        
        {% block unsubscribe %}
          <a href="https://example.com">Unsubscribe link</a>
        {% endblock %}
        ```
        
        [github-actions-image]: https://github.com/epfl-si/django-epfl-mail/workflows/Build/badge.svg?branch=main
        [github-actions-url]: https://github.com/epfl-si/django-epfl-mail/actions
        
        [codecov-image]:https://codecov.io/gh/epfl-si/django-epfl-mail/branch/main/graph/badge.svg
        [codecov-url]:https://codecov.io/gh/epfl-si/django-epfl-mail
        
        [pypi-python-image]: https://img.shields.io/pypi/pyversions/django-epfl-mail
        [pypi-image]: https://img.shields.io/pypi/v/django-epfl-mail
        [pypi-url]: https://pypi.org/project/django-epfl-mail/
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
Description-Content-Type: text/markdown
