https://github.com/apsl/django-email-foundation

Package for help you to make ease build email templates in your project.
https://github.com/apsl/django-email-foundation

django email-foundation emails inky panini

Last synced: about 1 year ago
JSON representation

Package for help you to make ease build email templates in your project.

• Host: GitHub
• URL: https://github.com/apsl/django-email-foundation
• Owner: APSL
• License: mit
• Created: 2019-03-14T17:45:00.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-05-20T10:01:10.000Z (about 6 years ago)
• Last Synced: 2025-03-24T12:12:44.356Z (over 1 year ago)
• Topics: django, email-foundation, emails, inky, panini
• Language: Python
• Size: 445 KB
• Stars: 5
• Watchers: 6
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • Contributing: docs/contributing.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
# django-email-foundation

[![django-email-foundation in Travis](https://travis-ci.org/APSL/django-email-foundation.svg?branch=master)](https://travis-ci.org/APSL/django-email-foundation)

[![django-email-foundation in PyPi](https://img.shields.io/pypi/v/django-email-foundation.svg)](https://pypi.python.org/pypi/django-email-foundation)

[![django-email-foundation in Readthedocs](https://readthedocs.org/projects/django-email-foundation/badge/?version=latest)](http://django-email-foundation.readthedocs.org/en/latest/?badge=latest)

Package that helps you build email templates easier in your projects.

## Description

It's a Django package that helps you to build email templates for your email engine sender (we recommend you to use `django-yubin`_).

It uses the `zurb foundation for emails`_ templates and `node` packages such as `inky` or `panini`.

* [django-yubin](https://github.com/APSL/django-yubin)

* [zurb foundation for emails](https://foundation.zurb.com/emails/docs/)

This gives you some commands and functionality to integrate *zurb foundation for emails* in your Django project.

* *install_requires*: A command for install the required node packages, such as *inky*, *panini*, *gulp*, etc., in your project.

* *create_basic_structure*: It creates in your project an essential folder tree which contains the basic layout and folders

  such as *pages*, *helpers* and *partials*, used by panini_.

* *email_builder*: Run a *gulp* process to watch your source templates, build and move to your target email folder. It compiles

  the sources using panini_ and inky_ for the best compatibility with the major email clients.

Also, it gives you a Django view to preview the build templates and use a custom fixed context for each one, useful for your

designers that may edit the layouts.

* [panini](https://www.npmjs.com/package/panini)

* [inky](https://www.npmjs.com/package/inky)

## Documentation

Please read the full documentation at [readthedocs](http://django-email-foundation.readthedocs.org/en/latest/)