Skip to main content

django-wysiwyg-redactor is a lightweight responsive wysiwyg editor for Django

Project description

A lightweight wysiwyg editor for Django

.. image::
:alt: Downloads

Some changes:

- redactorjs 7.6.3 (changes the [license](#license) too)
- new API methods
- `$('#redactor').getSelection()` get the selected content in editor
- `$('#redactor').getSettings()` you can get and set settings anytime you want
- removing some ajax calls, (modal windows), to avoid the crossdomain issue on production env
- with the *extra_script* option/setting you can load some script to do something more after load the redactor
- now the redactor toolbar is more responsive
- fixing some bugs, adapting things...


.. image::

What's that

*django-wysiwyg-redactor* is a reusable application for Django, using `Redactor WYSIWYG editor <>`_


- `Django >= 1.3` # for static files
- `PIL` # for image upload

Getting started

- Install *django-wysiwyg-redactor*:

```pip install django-wysiwyg-redactor```

- Add `'redactor'` to INSTALLED_APPS.

- Add `url(r'^redactor/', include('redactor.urls'))`, to

- Add default config in (fot more settings, see `here <>`_)

.. code-block:: python

REDACTOR_OPTIONS = {'lang': 'en'}
REDACTOR_UPLOAD = 'uploads/'

Using in model

.. code-block:: python

from django.db import models
from redactor.fields import RedactorField

class Entry(models.Model):
title = models.CharField(max_length=250, verbose_name=u'Title')
short_text = RedactorField(verbose_name=u'Text')

or use custom parametrs:

.. code-block:: python

short_text = RedactorField(
redactor_options={'lang': 'en', 'focus': 'true'},

Using for only admin interface

.. code-block:: python
from django import forms
from redactor.widgets import RedactorEditor
from blog.models import Entry

class EntryAdminForm(forms.ModelForm):
class Meta:
model = Entry
widgets = {
'short_text': RedactorEditor(),

class EntryAdmin(admin.ModelAdmin):
form = EntryAdminForm

`RedactorEditor` takes the same parameters as `RedactorField`

Upload Handlers
SimpleUploader - The Standard Uploader. Will upload your file to REDACTOR_UPLOAD.

UUIDUploader - This handler will replace the original file name for an UUID.

DateDirectoryUploader - This handler saves the file in a directory based on the current server date.


For example, if I want to use the DateDirectoryUploader handler, I will put this on

.. code-block:: python

REDACTOR_UPLOAD_HANDLER = 'redactor.handlers.DateDirectoryUploader'

File Storages
*django-wysiwyg-redactor* defaults to using the default media storage for your Django application.

This can be overriden to use a different storage backend with this variable:

.. code-block::

REDACTOR_FILE_STORAGE = 'my_site.file_storages.storage_instance'

Information on writing a custom storage backend is `here in the Django documentation <>`_.

Other third-party libraries exist to provide storage backends for cloud object storages (e.g. `django-cumulus <>`_ for Rackspace/OpenStack or `django-storages <>`_ for Amazon S3).

NOTE: Soon we will have a better documentation.


1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request =]

- Jun 06, 2014

- Added: Support for custom REDACTOR_FILE_STORAGE ( pull #45 #46 ) Thanks to @pztrick

- 0.3.9 Mar 29, 2014

- New Feature: Upload Handler (pull #43) Special Thanks to @SilentSokolov
- Fix unicode filename issue.

- Feb 14, 2014

- Improvement: Rename uploaded image by dint of uuid ( pull #33 )

- Feb 13, 2014

- Fix: Solve Deprecation of 'simplejson' ( pull #25 )

- previous versions

- Lots of fixes, see the commits.

Who is behind this?
Awesome people, you should see the `AUTHORS <>`_ file.

Starting with version 7.6.3 redactor-js is licensed under `Creative Commons Attribution-NonCommercial 3.0 license <>`_

If you want to use a newer version please buy license `here <>`_

Project details

Download files

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

Source Distribution

django-wysiwyg-redactor- (94.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page