Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mgd020/mjml-python
A python library for MJML - a framework that makes responsive-email easy
https://github.com/mgd020/mjml-python
email mjml python responsive
Last synced: 9 days ago
JSON representation
A python library for MJML - a framework that makes responsive-email easy
- Host: GitHub
- URL: https://github.com/mgd020/mjml-python
- Owner: mgd020
- License: mit
- Created: 2022-10-10T10:20:31.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-16T22:13:30.000Z (11 months ago)
- Last Synced: 2024-05-17T00:28:14.752Z (8 months ago)
- Topics: email, mjml, python, responsive
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 30
- Watchers: 1
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# mjml-python
Compile MJML at runtime without an external Node service/process. It is a Python wrapper for [MRML](https://github.com/jdrouet/mrml) (Rust port of [MJML](https://github.com/mjmlio/mjml)).
## Why
From [MRML](https://github.com/jolimail/mrml#why):
> 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](https://pypi.org/project/mjml-python/):
```sh
pip install mjml-python
```
Import `mjml2html` and pass a string to compile:
```py
from mjml import mjml2html
html = mjml2html(
'''
Hello World
Facebook
Google
Twitter
''',
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**
```py
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,
'[email protected]',
['[email protected]'],
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 to `None`, the following default fonts will be used:
```py
{
"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
With [Nix](https://nixos.org/):
```sh
nix-shell
```
With Python 3.7+, Rust and Cargo installed:
```sh
python3 -m venv env
source env/bin/activate
pip install -r requirements.txt
maturin develop
python -m unittest
```