A Python wrapper for MRML (Rust port of MJML).
Project description
mjml-python
Compile MJML at runtime without an external Node service/process. It is a Python wrapper for MRML (Rust port of MJML).
Why
From MRML:
A Node.js server rendering an MJML template takes around 20 MB of RAM at startup and 130 MB under stress test. In Rust, less than 1.7 MB at startup and a bit less that 3 MB under stress test. The Rust version can also handle twice as many requests per second.
All of that is without considering http transaction cost when using a node service or process.
How
Install from PyPI:
pip install mjml-python
Import mjml2html
and pass a string to compile:
from mjml import mjml2html
html = mjml2html(
'''
<mjml>
<mj-body>
<mj-section>
<mj-column>
<mj-image width="100px" src="/assets/img/logo-small.png"></mj-image>
<mj-divider border-color="#F45E43"></mj-divider>
<!-- Say hello to the user -->
<mj-text font-size="20px" color="#F45E43" font-family="Open Sans">Hello World</mj-text>
</mj-column>
</mj-section>
<mj-section>
<mj-column>
<mj-social font-size="15px" icon-size="30px" mode="horizontal">
<mj-social-element name="facebook" href="https://mjml.io/">
Facebook
</mj-social-element>
<mj-social-element name="google" href="https://mjml.io/">
Google
</mj-social-element>
<mj-social-element name="twitter" href="https://mjml.io/">
Twitter
</mj-social-element>
</mj-social>
</mj-column>
</mj-section>
</mj-body>
</mjml>
''',
disable_comments=True,
social_icon_origin="https://example.com",
fonts={
"Open Sans": "https://fonts.googleapis.com/css?family=Open+Sans:300,400,500,700",
"Ubuntu": "https://fonts.googleapis.com/css?family=Ubuntu:300,400,500,700",
})
Example using Django templates
from django.core.mail import send_mail
from django.template.loader import render_to_string
from mjml import mjml2html
context = {'foo': 'bar'}
text_message = render_to_string('my_text_template.txt', context)
html_message = mjml2html(render_to_string('my_mjml_template.mjml', context))
send_mail(
'Subject here',
text_message,
'from@example.com',
['to@example.com'],
fail_silently=False,
html_message=html_message,
)
Options
mjml-python
supports the following options:
Name | Type | Default value | Comment |
---|---|---|---|
disable_comments |
bool |
False |
Strip comments out of rendered HTML |
social_icon_origin |
str | None |
None |
Custom URL origin for social icons. Icon name is appended (e.g. facebook.png ). |
fonts |
dict[str, str] | None |
None |
Fonts imported in the HTML rendered by MJML. |
include_loader |
Callable[[str], str] | None |
None |
Fetch the included template using the path attribute. |
Notes :
- When
fonts
option is set toNone
, the following default fonts will be used:{ "Open Sans": "https://fonts.googleapis.com/css?family=Open+Sans:300,400,500,700", "Droid Sans": "https://fonts.googleapis.com/css?family=Droid+Sans:300,400,500,700", "Lato": "https://fonts.googleapis.com/css?family=Lato:300,400,500,700", "Roboto": "https://fonts.googleapis.com/css?family=Roboto:300,400,500,700", "Ubuntu": "https://fonts.googleapis.com/css?family=Ubuntu:300,400,500,700", }
Development
python -m venv env
source env/bin/activate
pip install -r requirements.txt
maturin develop
python -m unittest
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 Distributions
Built Distributions
Hashes for mjml_python-1.3.1-cp37-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 499554013eee5dbe1400c5477a59058fcecef300a75db6be1309a2258bf1657e |
|
MD5 | e637574bbaa9feece34c79360cd33eec |
|
BLAKE2b-256 | 1be599e8f09006177340b6b2f6d5a64e6a3562077dc89be90bc7b356881febd2 |
Hashes for mjml_python-1.3.1-cp37-abi3-musllinux_1_2_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18ffaefdc5ad78feb7046ffa9070dbd62dc5f579c6c9daa300efec7997d04c46 |
|
MD5 | 7add076f8ac850756cbb10de5260c150 |
|
BLAKE2b-256 | 4f9236115bc6a2de18c9b1e10321cab490035f297f7b7478fa55ec2a0d3b0439 |
Hashes for mjml_python-1.3.1-cp37-abi3-musllinux_1_2_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5ae954158958afbcdb1b37f954575b59c6b563aca382b92b22192c4dce5d52f |
|
MD5 | 01041050ad7db755236924e4b9b167fe |
|
BLAKE2b-256 | e2235ca6c68bf09156c4f91590550eb5db742ab2106cae80dad1eaefacbf4732 |
Hashes for mjml_python-1.3.1-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e8f67e777d32c86caa5706aa4b84049bb55587bfb038090d4d33134a5c2f98b |
|
MD5 | 9415a6a2645c0b0ebe045de67fb589ee |
|
BLAKE2b-256 | 9ee1daff1e9ec88e36620d87e0538b2feec1219e0f33fc8e707b257c01901b37 |
Hashes for mjml_python-1.3.1-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e874e306c61caa8ea172764d9f18481f9fbb67931349ba19e434545b0447db9e |
|
MD5 | 2b1e12fbb147e61c21ab305b484031c2 |
|
BLAKE2b-256 | 6058ffaaa627cb668b98e162f9ec03600bf39154041532108aebb4331853077f |
Hashes for mjml_python-1.3.1-cp37-abi3-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a61e9233cecfb02daaebfe6824a6f5e104815ae608f0515d9c8c56c4df85a53 |
|
MD5 | a02435189df621efcccb4418328404fa |
|
BLAKE2b-256 | e7bf3d4a688f3dddafbe4270847d180310bef6e99623a7a09a02655492e2a9e0 |