A lightweight wysiwyg editor for Django

Screenshot

What's that

django-wysiwyg-redactor is a reusable application for Django, using Redactor WYSIWYG editor

Sponsored by Mess Marketing, we use the latest version of redactorjs, always up-to-date.

Dependence

• Django >= 1.3 # for static files
• Pillow or 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 urls.py
• Add default config in settings.py

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

More redactor settings.

Using in model

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:

short_text = RedactorField(
    verbose_name=u'Text',
    redactor_options={'lang': 'en', 'focus': 'true'},
    upload_to='tmp/',
    allow_file_upload=True,
    allow_image_upload=True
)

Using for only admin interface

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.

Usage:

For example, if I want to use the DateDirectoryUploader handler, I will put this on settings.py:

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 settings.py variable:

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.

Contributing

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 =]

History

• 0.4.0 sep 11, 2014
  • Great news, now we have an sponsor, which means we can use a up-to-date version of redactorjs. Thanks to @etchalon. ( pull #48 )
  • Working with python3.4
  • Update LICENSE
  • Better error handling
• 0.3.9.1 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.
• 0.3.8.2 Feb 14, 2014
  • Improvement: Rename uploaded image by dint of uuid ( pull #33 )
• 0.3.8.1 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.

And our awesome sponsor:

Mess Marketing from Chicago, IL [email protected] thisismess.com @etchalon

License

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