django-mjml-template


Namedjango-mjml-template JSON
Version 1.0.0 PyPI version JSON
download
home_pageNone
SummarySimple and fast MJML rendering for Django templates.
upload_time2025-08-07 04:49:27
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseNone
keywords django mjml template
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![CI](https://github.com/Cruel/django-mjml-template/actions/workflows/ci.yml/badge.svg)](https://github.com/Cruel/django-mjml-template/actions/workflows/ci.yml) [![pypi](https://img.shields.io/pypi/v/django-mjml-template.svg)](https://pypi.org/project/django-mjml-template/)

# Django MJML Template

Use MJML in your Django templates. A very small and fast implementation.

## About

This
package leverages [MRML](https://github.com/jdrouet/mrml), a Rust implementation
of [MJML](https://github.com/mjmlio/mjml) using bindings provided by [mjml-python](https://github.com/mgd020/mjml-python).

If you want to run `MJML` itself as a separate HTTP server endpoint for conversion, use [django-mjml](https://github.com/liminspace/django-mjml) instead. It uses the same `mjml` template tag.

## What is MJML?

From the [documentation](https://documentation.mjml.io/) of the project:

> MJML is a markup language designed to reduce the pain of coding a responsive
> email. Its semantic syntax makes it easy and straightforward and its rich
> standard components library speeds up your development time and lightens your
> email codebase. MJML’s open-source engine generates high quality responsive
> HTML compliant with best practices.

## Requirements

- Python >= 3.7
- Django >= 1.11

## Installation

To install the package, run the following command:

```bash
pip install django-mjml-template
```

Then update your `settings.py`:

```python
INSTALLED_APPS = (
    ...
    'django_mjml_template',
)
```

## Usage

Load `mjml` in your django template and use `mjml` tag that will compile MJML to HTML:

```html
{% load mjml %}

{% mjml %}
  <mjml>
    <mj-body>
      <mj-section>
        <mj-column>
          <mj-text>Hello {{ user_name }}!</mj-text>
        </mj-column>
      </mj-section>
    </mj-body>
  </mjml>
{% endmjml %}
```

## Contributions

Contributions, bug reports, and suggestions are welcome! Feel free to open an
issue or submit a pull request.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "django-mjml-template",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "django, mjml, template",
    "author": null,
    "author_email": "Thomas Edvalson <machin3@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/fd/b7/086ad5ad3a1ee1bd1465b4b727a2f0a2c72d6e8990f052fff6c039e17d7c/django_mjml_template-1.0.0.tar.gz",
    "platform": null,
    "description": "[![CI](https://github.com/Cruel/django-mjml-template/actions/workflows/ci.yml/badge.svg)](https://github.com/Cruel/django-mjml-template/actions/workflows/ci.yml) [![pypi](https://img.shields.io/pypi/v/django-mjml-template.svg)](https://pypi.org/project/django-mjml-template/)\n\n# Django MJML Template\n\nUse MJML in your Django templates. A very small and fast implementation.\n\n## About\n\nThis\npackage leverages [MRML](https://github.com/jdrouet/mrml), a Rust implementation\nof [MJML](https://github.com/mjmlio/mjml) using bindings provided by [mjml-python](https://github.com/mgd020/mjml-python).\n\nIf you want to run `MJML` itself as a separate HTTP server endpoint for conversion, use [django-mjml](https://github.com/liminspace/django-mjml) instead. It uses the same `mjml` template tag.\n\n## What is MJML?\n\nFrom the [documentation](https://documentation.mjml.io/) of the project:\n\n> MJML is a markup language designed to reduce the pain of coding a responsive\n> email. Its semantic syntax makes it easy and straightforward and its rich\n> standard components library speeds up your development time and lightens your\n> email codebase. MJML\u2019s open-source engine generates high quality responsive\n> HTML compliant with best practices.\n\n## Requirements\n\n- Python >= 3.7\n- Django >= 1.11\n\n## Installation\n\nTo install the package, run the following command:\n\n```bash\npip install django-mjml-template\n```\n\nThen update your `settings.py`:\n\n```python\nINSTALLED_APPS = (\n    ...\n    'django_mjml_template',\n)\n```\n\n## Usage\n\nLoad `mjml` in your django template and use `mjml` tag that will compile MJML to HTML:\n\n```html\n{% load mjml %}\n\n{% mjml %}\n  <mjml>\n    <mj-body>\n      <mj-section>\n        <mj-column>\n          <mj-text>Hello {{ user_name }}!</mj-text>\n        </mj-column>\n      </mj-section>\n    </mj-body>\n  </mjml>\n{% endmjml %}\n```\n\n## Contributions\n\nContributions, bug reports, and suggestions are welcome! Feel free to open an\nissue or submit a pull request.\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Simple and fast MJML rendering for Django templates.",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/Cruel/django-mjml-template",
        "Issues": "https://github.com/Cruel/django-mjml-template/issues/"
    },
    "split_keywords": [
        "django",
        " mjml",
        " template"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "165fa80d832c6c8c239859313f30bb86e0184c0d31be4ccf4f7a6882f54e4730",
                "md5": "15c215a1bf3bbfa0ca4573d8300bedbb",
                "sha256": "9bb50ea911dc5edcad14d8a82c5624591a664d9de44cc4b1815a2d43934830a5"
            },
            "downloads": -1,
            "filename": "django_mjml_template-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "15c215a1bf3bbfa0ca4573d8300bedbb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 4286,
            "upload_time": "2025-08-07T04:49:26",
            "upload_time_iso_8601": "2025-08-07T04:49:26.522151Z",
            "url": "https://files.pythonhosted.org/packages/16/5f/a80d832c6c8c239859313f30bb86e0184c0d31be4ccf4f7a6882f54e4730/django_mjml_template-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "fdb7086ad5ad3a1ee1bd1465b4b727a2f0a2c72d6e8990f052fff6c039e17d7c",
                "md5": "a62300330048c37d082043277bfffe31",
                "sha256": "f9f69b2610419d8414989f5f53415e9802901821d1e08f6a41a277ff83180815"
            },
            "downloads": -1,
            "filename": "django_mjml_template-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a62300330048c37d082043277bfffe31",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 5570,
            "upload_time": "2025-08-07T04:49:27",
            "upload_time_iso_8601": "2025-08-07T04:49:27.654281Z",
            "url": "https://files.pythonhosted.org/packages/fd/b7/086ad5ad3a1ee1bd1465b4b727a2f0a2c72d6e8990f052fff6c039e17d7c/django_mjml_template-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-07 04:49:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Cruel",
    "github_project": "django-mjml-template",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "django-mjml-template"
}
        
Elapsed time: 1.75365s