# django-tinymce4-widget
<p align="center">
<a href="https://github.com/browniebroke/django-tinymce4-widget/actions/workflows/ci.yml?query=branch%3Amain">
<img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/browniebroke/django-tinymce4-widget/ci.yml?branch=main&label=CI&logo=github&style=flat-square">
</a>
<a href="https://django-tinymce4-widget.readthedocs.io">
<img src="https://img.shields.io/readthedocs/django-tinymce4-widget.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
</a>
<a href="https://codecov.io/gh/browniebroke/django-tinymce4-widget">
<img src="https://img.shields.io/codecov/c/github/browniebroke/django-tinymce4-widget.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage">
</a>
<a href="https://results.pre-commit.ci/latest/github/browniebroke/django-tinymce4-widget/main">
<img src="https://results.pre-commit.ci/badge/github/browniebroke/django-tinymce4-widget/main.svg" alt="pre-commit.ci status">
</a>
</p>
<p align="center">
<a href="https://python-poetry.org/">
<img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">
</a>
<a href="https://github.com/ambv/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square" alt="black">
</a>
<a href="https://github.com/pre-commit/pre-commit">
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
</a>
</p>
<p align="center">
<a href="https://pypi.org/project/django-tinymce4-widget/">
<img src="https://img.shields.io/pypi/v/django-tinymce4-widget.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPi Status">
</a>
<img src="https://img.shields.io/pypi/pyversions/django-tinymce4-widget.svg?style=flat-square&logo=python&logoColor=fff" alt="pyversions">
<img src="https://img.shields.io/pypi/l/django-tinymce4-widget.svg?style=flat-square" alt="license">
</p>
---
**Documentation**: <a href="https://django-tinymce4-widget.readthedocs.io" target="_blank">https://django-tinymce4-widget.readthedocs.io</a>
**Source Code**: <a href="https://github.com/browniebroke/django-tinymce4-widget" target="_blank">https://github.com/browniebroke/django-tinymce4-widget</a>
---
> [!IMPORTANT]
> The latest version of TinyMCE (at time of writing) is version 6. This package is -and will stay- focused on TinyMCE 4 only. I no longer use this package myself so I have no incentive to keep it up to date. I recommend moving to a maintained alternative like [Jazzband](https://github.com/jazzband/django-tinymce) or alternatively fork it.
**django-tinymce4-widget** is a reworked fork of [django-tinymce4-lite](https://github.com/romanvm/django-tinymce4-lite). It provides a minimal [TinyMCE 4](https://www.tinymce.com/) editor widget that can be used in Django forms.
This version **does not** include any static files, it's using the TinyMCE from the CDN by default.
## Compatibility
- **Python**: 3.8-3.12
- **Django**: 3.2-5.0
## Quick Start
Install `django-tinymce4-widget`:
$ pip install django-tinymce4-widget
Add `tinymce` to `INSTALLED_APPS` in `settings.py` for your Django project:
```python
INSTALLED_APPS = (
...
'tinymce',
)
```
Add `tinymce.urls` to `urls.py` for your project:
```python
urlpatterns = [
...
path('tinymce/', include('tinymce.urls')),
...
]
```
In your code:
```python
from django.db import models
from tinymce import HTMLField
class MyModel(models.Model):
...
content = HTMLField('Content')
```
In Django Admin the widget is used automatically for all models that have `HTMLField` fields. If you are using TinyMCE 4 in your website forms, add `form.media` variable into your templates:
```django
<!DOCTYPE html>
<html>
<head>
...
{{ form.media }}
</head>
<body>
...
</body>
</html>
```
Raw data
{
"_id": null,
"home_page": "https://github.com/browniebroke/django-tinymce4-widget",
"name": "django-tinymce4-widget",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "django,wysiwyg,widget,tinymce",
"author": "Bruno Alla",
"author_email": "oss@browniebroke.com",
"download_url": "https://files.pythonhosted.org/packages/90/27/2bf75ac84377f99f5438241679a093bcc5c86af57103b9c12a96580c824e/django_tinymce4_widget-7.1.1.tar.gz",
"platform": null,
"description": "# django-tinymce4-widget\n\n<p align=\"center\">\n <a href=\"https://github.com/browniebroke/django-tinymce4-widget/actions/workflows/ci.yml?query=branch%3Amain\">\n <img alt=\"CI Status\" src=\"https://img.shields.io/github/actions/workflow/status/browniebroke/django-tinymce4-widget/ci.yml?branch=main&label=CI&logo=github&style=flat-square\">\n </a>\n <a href=\"https://django-tinymce4-widget.readthedocs.io\">\n <img src=\"https://img.shields.io/readthedocs/django-tinymce4-widget.svg?logo=read-the-docs&logoColor=fff&style=flat-square\" alt=\"Documentation Status\">\n </a>\n <a href=\"https://codecov.io/gh/browniebroke/django-tinymce4-widget\">\n <img src=\"https://img.shields.io/codecov/c/github/browniebroke/django-tinymce4-widget.svg?logo=codecov&logoColor=fff&style=flat-square\" alt=\"Test coverage\">\n </a>\n <a href=\"https://results.pre-commit.ci/latest/github/browniebroke/django-tinymce4-widget/main\">\n <img src=\"https://results.pre-commit.ci/badge/github/browniebroke/django-tinymce4-widget/main.svg\" alt=\"pre-commit.ci status\">\n </a>\n</p>\n<p align=\"center\">\n <a href=\"https://python-poetry.org/\">\n <img src=\"https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=\" alt=\"Poetry\">\n </a>\n <a href=\"https://github.com/ambv/black\">\n <img src=\"https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square\" alt=\"black\">\n </a>\n <a href=\"https://github.com/pre-commit/pre-commit\">\n <img src=\"https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square\" alt=\"pre-commit\">\n </a>\n</p>\n<p align=\"center\">\n <a href=\"https://pypi.org/project/django-tinymce4-widget/\">\n <img src=\"https://img.shields.io/pypi/v/django-tinymce4-widget.svg?logo=python&logoColor=fff&style=flat-square\" alt=\"PyPi Status\">\n </a>\n <img src=\"https://img.shields.io/pypi/pyversions/django-tinymce4-widget.svg?style=flat-square&logo=python&logoColor=fff\" alt=\"pyversions\">\n <img src=\"https://img.shields.io/pypi/l/django-tinymce4-widget.svg?style=flat-square\" alt=\"license\">\n</p>\n\n---\n\n**Documentation**: <a href=\"https://django-tinymce4-widget.readthedocs.io\" target=\"_blank\">https://django-tinymce4-widget.readthedocs.io</a>\n\n**Source Code**: <a href=\"https://github.com/browniebroke/django-tinymce4-widget\" target=\"_blank\">https://github.com/browniebroke/django-tinymce4-widget</a>\n\n---\n\n> [!IMPORTANT]\n> The latest version of TinyMCE (at time of writing) is version 6. This package is -and will stay- focused on TinyMCE 4 only. I no longer use this package myself so I have no incentive to keep it up to date. I recommend moving to a maintained alternative like [Jazzband](https://github.com/jazzband/django-tinymce) or alternatively fork it.\n\n**django-tinymce4-widget** is a reworked fork of [django-tinymce4-lite](https://github.com/romanvm/django-tinymce4-lite). It provides a minimal [TinyMCE 4](https://www.tinymce.com/) editor widget that can be used in Django forms.\n\nThis version **does not** include any static files, it's using the TinyMCE from the CDN by default.\n\n## Compatibility\n\n- **Python**: 3.8-3.12\n- **Django**: 3.2-5.0\n\n## Quick Start\n\nInstall `django-tinymce4-widget`:\n\n $ pip install django-tinymce4-widget\n\nAdd `tinymce` to `INSTALLED_APPS` in `settings.py` for your Django project:\n\n```python\nINSTALLED_APPS = (\n ...\n 'tinymce',\n)\n```\n\nAdd `tinymce.urls` to `urls.py` for your project:\n\n```python\nurlpatterns = [\n ...\n path('tinymce/', include('tinymce.urls')),\n ...\n]\n```\n\nIn your code:\n\n```python\nfrom django.db import models\nfrom tinymce import HTMLField\n\nclass MyModel(models.Model):\n ...\n content = HTMLField('Content')\n```\n\nIn Django Admin the widget is used automatically for all models that have `HTMLField` fields. If you are using TinyMCE 4 in your website forms, add `form.media` variable into your templates:\n\n```django\n<!DOCTYPE html>\n<html>\n<head>\n ...\n {{ form.media }}\n</head>\n<body>\n...\n</body>\n</html>\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Django application that provides a TinyMCE 4 editor widget without any static files",
"version": "7.1.1",
"project_urls": {
"Documentation": "https://django-tinymce4-widget.readthedocs.io",
"Homepage": "https://github.com/browniebroke/django-tinymce4-widget",
"Repository": "https://github.com/browniebroke/django-tinymce4-widget"
},
"split_keywords": [
"django",
"wysiwyg",
"widget",
"tinymce"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "03e580afebe43e4ca87329d7cd16085bea01d25d30f684f5fd55c02160201375",
"md5": "3329f05a94070bdbb7ddd57c5336834b",
"sha256": "f48065f03ff394861c3bf81dae5a2a6af0019ae1eed9a1ef7c5046f6bc63bdd7"
},
"downloads": -1,
"filename": "django_tinymce4_widget-7.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3329f05a94070bdbb7ddd57c5336834b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 11026,
"upload_time": "2023-11-28T23:00:07",
"upload_time_iso_8601": "2023-11-28T23:00:07.585279Z",
"url": "https://files.pythonhosted.org/packages/03/e5/80afebe43e4ca87329d7cd16085bea01d25d30f684f5fd55c02160201375/django_tinymce4_widget-7.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "90272bf75ac84377f99f5438241679a093bcc5c86af57103b9c12a96580c824e",
"md5": "274f414ecc96c89675cd6ac285fa9639",
"sha256": "52f2dd80bc7731f7745086fb3c50378f756bb8dd8f80fa6f650b06f3a792652c"
},
"downloads": -1,
"filename": "django_tinymce4_widget-7.1.1.tar.gz",
"has_sig": false,
"md5_digest": "274f414ecc96c89675cd6ac285fa9639",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 11477,
"upload_time": "2023-11-28T23:00:10",
"upload_time_iso_8601": "2023-11-28T23:00:10.379132Z",
"url": "https://files.pythonhosted.org/packages/90/27/2bf75ac84377f99f5438241679a093bcc5c86af57103b9c12a96580c824e/django_tinymce4_widget-7.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-28 23:00:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "browniebroke",
"github_project": "django-tinymce4-widget",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-tinymce4-widget"
}
JSON
