Metadata-Version: 1.1
Name: django-mjml
Version: 0.8.0
Summary: Use MJML in Django templates
Home-page: https://github.com/liminspace/django-mjml
Author: Igor Melnyk @liminspace
Author-email: liminspace@gmail.com
License: MIT
Description: .. image:: https://travis-ci.org/liminspace/django-mjml.svg?branch=master
         :target: https://travis-ci.org/liminspace/django-mjml
         :alt: build
        
        .. image:: https://img.shields.io/pypi/v/django-mjml.svg
         :target: https://pypi.org/project/django-mjml/
         :alt: pypi
        
        |
        
        .. image:: https://cloud.githubusercontent.com/assets/5173158/14615647/5fc03bf8-05af-11e6-8cdd-f87bf432c4a2.png
          :target: #
          :alt: Django + MJML
        
        django-mjml
        ===========
        
        The simplest way to use `MJML <https://mjml.io/>`_ in `Django <https://www.djangoproject.com/>`_ templates.
        
        |
        
        Installation
        ------------
        
        **Requirements:**
        
        * Django v1.8+
        * mjml v2.3+ (under node v8)
        
        **\1\. Install** ``mjml``.
        
        See https://github.com/mjmlio/mjml#installation and https://mjml.io/documentation/#installation
        
        **\2\. Install** ``django-mjml``.
        
        * Via pip::
        
          $ pip install django-mjml
        
        * Via setuptools::
        
          $ easy_install django-mjml
        
        
         For install development version use ``git+https://github.com/liminspace/django-mjml.git@develop`` instead ``django-mjml``.
        
        **\3\. Set up** ``settings.py`` **in your django project.** ::
        
          INSTALLED_APPS = (
            ...,
            'mjml',
          )
        
        |
        
        Usage
        -----
        
        Load ``mjml`` in your django template and use ``mjml`` tag that will compile mjml to html::
        
          {% load mjml %}
        
          {% mjml %}
              <mjml>
              <mj-body>
              <mj-container>
                  <mj-section>
                      <mj-column>
                          <mj-text>Hello world!</mj-text>
                      </mj-column>
                  </mj-section>
              </mj-container>
              </mj-body>
              </mjml>
          {% endmjml %}
        
        |
        
        Advanced settings
        -----------------
        
        There are two backend modes for compiling: ``cmd`` and ``tcpserver``.
        
        **cmd mode**
        
        This mode is very simple, slow and used by default. ::
        
          MJML_BACKEND_MODE = 'cmd'
          MJML_EXEC_CMD = 'mjml'
        
        You can change ``MJML_EXEC_CMD`` and set path to executable ``mjml`` file, for example::
        
          MJML_EXEC_CMD = '/home/user/node_modules/.bin/mjml'
        
        Also you can pass addition cmd arguments, for example::
        
          MJML_EXEC_CMD = ['node_modules/.bin/mjml', '--config.minify', 'true', '--config.validationLevel', 'strict']
        
        Once you have a working installation, you can skip the sanity check on startup to speed things up::
        
          MJML_CHECK_CMD_ON_STARTUP = False
        
        **tcpserver mode**
        
        This mode is faster than ``cmd`` but it needs run a server process in background. ::
        
          MJML_BACKEND_MODE = 'tcpserver'
          MJML_TCPSERVERS = [
              ('127.0.0.1', 28101),  # host and port
          ]
        
        You can set several servers and it will be used random one::
        
          MJML_TCPSERVERS = [
              ('127.0.0.1', 28101),
              ('127.0.0.1', 28102),
              ('127.0.0.1', 28103),
          ]
        
        You can run servers by commands::
        
          # NODE_PATH=/home/user/node_modules node /home/user/.virtualenv/default/lib/python2.7/site-packages/mjml/node/tcpserver.js --port=28101 --host=127.0.0.1 --touchstop=/tmp/mjmltcpserver.stop
        
        ``28101`` - port, ``127.0.0.1`` - host, ``/tmp/mjmltcpserver.stop`` - file that will stop server after touch.
        
        For daemonize server process you can use, for example, supervisor::
        
          /etc/supervisor/conf.d/mjml.conf
        
          [program:mjmltcpserver]
          user=user
          environment=NODE_PATH=/home/user/node_modules
          command=node
              /home/user/.virtualenv/default/lib/python2.7/site-packages/mjml/node/tcpserver.js
              --port=28101 --host=127.0.0.1 --touchstop=/tmp/mjmltcpserver.stop --mjml.minify=true --mjml.validationLevel=strict
          stdout_logfile=/home/user/project/var/log/supervisor/mjml.log
          autostart=true
          autorestart=true
          redirect_stderr=true
          stopwaitsecs=10
          stopsignal=INT
        
        Or you can use docker-compose::
        
          services:
            mjml-1:
              image: liminspace/mjml-tcpserver:latest
              restart: always
              ports:
                - "28101:28101"
        
            mjml-2:
              image: liminspace/mjml-tcpserver:latest
              restart: always
              environment:
                HOST: "0.0.0.0"
                PORT: "28102"
                MJML_ARGS: "--mjml.minify=true --mjml.validationLevel=strict"
              expose:
                - "28102"
              ports:
                - "28102:28102"
        
        
Keywords: django,mjml,django-mjml,email,layout,template,templatetag
Platform: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
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: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: MIT License
