# AX3 Redactor
This app is part of the AX3 technology developed by Axiacore.
It will allow to use redactor inside the django admin interface.
## Quick start
1. Add "redactor" to your INSTALLED_APPS setting like this:
```python
INSTALLED_APPS = [
...
'redactor',
]
```
2. Include the redactor URLconf in your project urls.py like this:
```python
path('', include('redactor.urls')),
```
3. Run `python manage.py migrate` to create the redactor models.
4. Copy this redactor library files into a `static` folder in your proyect:
```python
vendor/redactor/redactor.min.css
vendor/redactor/redactor.min.js
vendor/redactor/plugins/imagemanager.min.js
vendor/redactor/plugins/video.min.js
vendor/redactor/plugins/widget.min.js
```
5. Add to the admin.py the redactor support for a given model:
```python
from django.contrib import admin
from redactor.mixins import RedactorMixin
from .models import Post
@admin.register(Post)
class PostAdmin(RedactorMixin, admin.ModelAdmin):
...
redactor_fields = ['content']
...
```
`content` is a `TextField` attribute at the `Post` model.
You can use multiple fields.
## Releasing a new version
Make sure you have an API Token for PyPI: https://pypi.org/help/#apitoken
Make sure you increase the version number and create a git tag:
```bash
$ python3 -m pip install --user --upgrade setuptools wheel twine
$ ./release.sh
```
Made by [Axiacore](https://axiacore.com).
Raw data
{
"_id": null,
"home_page": "https://github.com/Axiacore/ax3-redactor",
"name": "ax3-redactor",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Axiacore",
"author_email": "info@axiacore.com",
"download_url": "https://files.pythonhosted.org/packages/df/61/5a6cdbc4abe016c7ec222ba2624eb02f89f573a24ab9a3c5d135e4bdb11e/ax3-redactor-2.0.0.tar.gz",
"platform": null,
"description": "# AX3 Redactor\n\nThis app is part of the AX3 technology developed by Axiacore.\n\nIt will allow to use redactor inside the django admin interface.\n\n## Quick start\n\n1. Add \"redactor\" to your INSTALLED_APPS setting like this:\n\n```python\n INSTALLED_APPS = [\n ...\n 'redactor',\n ]\n```\n\n2. Include the redactor URLconf in your project urls.py like this:\n\n```python\n path('', include('redactor.urls')),\n```\n\n3. Run `python manage.py migrate` to create the redactor models.\n\n4. Copy this redactor library files into a `static` folder in your proyect:\n\n```python\n vendor/redactor/redactor.min.css\n vendor/redactor/redactor.min.js\n vendor/redactor/plugins/imagemanager.min.js\n vendor/redactor/plugins/video.min.js\n vendor/redactor/plugins/widget.min.js\n```\n\n5. Add to the admin.py the redactor support for a given model:\n\n```python\n from django.contrib import admin\n\n from redactor.mixins import RedactorMixin\n\n from .models import Post\n\n\n @admin.register(Post)\n class PostAdmin(RedactorMixin, admin.ModelAdmin):\n ...\n\n redactor_fields = ['content']\n\n ...\n```\n\n`content` is a `TextField` attribute at the `Post` model.\nYou can use multiple fields.\n\n## Releasing a new version\n\nMake sure you have an API Token for PyPI: https://pypi.org/help/#apitoken\n\nMake sure you increase the version number and create a git tag:\n\n```bash\n$ python3 -m pip install --user --upgrade setuptools wheel twine\n$ ./release.sh\n```\n\nMade by [Axiacore](https://axiacore.com).\n",
"bugtrack_url": null,
"license": "",
"summary": "A Django app to add support for redactor",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/Axiacore/ax3-redactor"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b61747d7089b86b2e88058fbc9709c622c8ac3200a7b52c3d7db72007b4ef928",
"md5": "22f40861ae9cfc3ef47b356039adae56",
"sha256": "5eea10467effdd9c01cc54f681692302659438e34edfd7a7fd8546c271d244e5"
},
"downloads": -1,
"filename": "ax3_redactor-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22f40861ae9cfc3ef47b356039adae56",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6607,
"upload_time": "2023-07-05T23:33:09",
"upload_time_iso_8601": "2023-07-05T23:33:09.513699Z",
"url": "https://files.pythonhosted.org/packages/b6/17/47d7089b86b2e88058fbc9709c622c8ac3200a7b52c3d7db72007b4ef928/ax3_redactor-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df615a6cdbc4abe016c7ec222ba2624eb02f89f573a24ab9a3c5d135e4bdb11e",
"md5": "fd86d98753496fdfbf8341541cc9f58e",
"sha256": "fd6ee56b8400954f9d633bdc9c91c805a115d3aefd97b6681b08a28347ce7d3f"
},
"downloads": -1,
"filename": "ax3-redactor-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "fd86d98753496fdfbf8341541cc9f58e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6281,
"upload_time": "2023-07-05T23:33:10",
"upload_time_iso_8601": "2023-07-05T23:33:10.980215Z",
"url": "https://files.pythonhosted.org/packages/df/61/5a6cdbc4abe016c7ec222ba2624eb02f89f573a24ab9a3c5d135e4bdb11e/ax3-redactor-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-05 23:33:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Axiacore",
"github_project": "ax3-redactor",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ax3-redactor"
}
JSON
