Skip to main content

A django admin widget to render a text field as beautiful Imperavi WYSIWYG editor http://redactorjs.com/

Project description

Django Imperavi editor
======================
Supported versions
------------
Supports Django >=1.8 and Python 2/3

Installation
------------
```
pip install git+https://github.com/dzaytsev91/django-imperavi-widget.git
```

* Add ``imperavi`` to your ``INSTALLED_APPS`` setting.

* Add imperavi URL include to your project's ``urls.py`` file::

```
url(r'^imperavi/', include('imperavi.urls')),
```

Example
-----
```
cd example/
python manage.py migrate
./manage.py shell -c "from django.contrib.auth.models import User; User.objects.create_superuser('admin', 'admin@example.com', 'admin')"
python manage.py runserver
```
Then go to [http://127.0.0.1:8000/admin/](127.0.0.1:8000/admin/) and try to create post instance

login: admin
password: admin


Usage
-----

The quickest way to add rich text editing capabilities to your admin is to use the included ``ImperaviAdmin`` class. For example::

from .models import Category
from imperavi.admin import ImperaviAdmin

class CategotyAdmin(ImperaviAdmin):
pass

admin.site.register(Category, CategotyAdmin)

If you want to use it with inline admin models you need to use ``ImperaviStackedInlineAdmin`` class::

from .models import Post
from imperavi.admin import ImperaviStackedInlineAdmin

class PostInline(ImperaviStackedInlineAdmin):
model = Post
extra = 1

Custom settings
---------------

Add a ``IMPERAVI_CUSTOM_SETTINGS`` variable to your ``settings.py`` with custom config::

IMPERAVI_CUSTOM_SETTINGS = {
'resize': true
}

Full list of settings is here.
[http://redactorjs.com/docs/settings/](ttp://redactorjs.com/docs/settings/)

Media URL
---------

You can also customize the URL that django-imperavi-widget will look for the Editor media at by adding ``IMPERAVI_UPLOAD_PATH`` to your ``settings.py`` file like this::

IMPERAVI_UPLOAD_PATH = 'imperavi-uploads/'

The default value is ``'imperavi/'``.


Unique images per model
-----------------------

If you want to serve unique media content for specific model you can add ``unique_media = True`` to your admin class::

from .models import Category
from imperavi.admin import ImperaviAdmin

class CategotyAdmin(ImperaviAdmin):
unique_media = True

admin.site.register(Category, CategotyAdmin)

Project details


Release history Release notifications

This version
History Node

0.0.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-imperavi-widget-0.0.3.tar.gz (159.0 kB) Copy SHA256 hash SHA256 Source None Jun 27, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page