Skip to main content

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

Project description

Screenshot

https://raw.githubusercontent.com/douglasmiranda/django-wysiwyg-redactor/master/screenshots/redactor.jpg

What’s that

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

Dependency

  • Pillow or PIL # for image upload

Getting started

  • Install django-wysiwyg-redactor:

pip install django-wysiwyg-redactor

  • Add ‘redactor’ to INSTALLED_APPS.

INSTALLED_APPS = (
    # ...
    'redactor',
    # ...
)
  • Add url(r’^redactor/’, include(‘redactor.urls’)), to urls.py

urlpatterns = [
    # ...
    url(r'^redactor/', include('redactor.urls')),
    # ...
]
  • 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 parameters:

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 only in Django Admin

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.

Using Plugins

Download the plugin you want or create a custom plugin.

Then:

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',
        # for example, if you downloaded the 'table' plugin:
        redactor_options={'plugins': ['table']}
    )

OR (on settings.py):

REDACTOR_OPTIONS = {'lang': 'en', 'plugins': ['table']}

Important: if you set a plugin called “table”, you must create/paste the “table.js” on YOUR_STATIC_FILES_FOLDER/redactor/plugins/table.js

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'

Upload permissions

By default django-wysiwyg-redactor uses staff_member_required decorator from django.contrib.admin.views.decorators package to control access to dispatch method.

To use custom authentication decorator, set REDACTOR_AUTH_DECORATOR to anything else, eg. if every authenticated user should have permissions to upload files/images/etc.:

REDACTOR_AUTH_DECORATOR = 'django.contrib.auth.decorators.login_required'

File Storages

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

This can be overridden to use a different storage backend with this settings.py variable:

REDACTOR_FILE_STORAGE = 'my_site.file_storages.StorageClass'

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). For example, following should be enough to store all your files and images to Amazon S3, even if the rest of the application uses different storage.

REDACTOR_FILE_STORAGE = 'storages.backends.s3boto.S3BotoStorage'
AWS_ACCESS_KEY_ID = '...'
AWS_SECRET_ACCESS_KEY = '...'
AWS_STORAGE_BUCKET_NAME = '...'

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

Made by robots, or what?

Awesome people, you should see the AUTHORS file.

About the licensing

You may want to see the LICENSE file.

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-0.5.0.tar.gz (152.4 kB view details)

Uploaded Source

Built Distribution

django_wysiwyg_redactor-0.5.0-py2-none-any.whl (168.4 kB view details)

Uploaded Python 2

File details

Details for the file django-wysiwyg-redactor-0.5.0.tar.gz.

File metadata

File hashes

Hashes for django-wysiwyg-redactor-0.5.0.tar.gz
Algorithm Hash digest
SHA256 2043e181f16ce3e52e32e8fd5993752db6535e47aa997ea2da98b72121896c4e
MD5 5abe2bfd5417c7c29f75718e45788634
BLAKE2b-256 755e465e014b993a7e6d08e8a0f104cec9b9b0f8bb7d9287f114d77a63edc775

See more details on using hashes here.

File details

Details for the file django_wysiwyg_redactor-0.5.0-py2-none-any.whl.

File metadata

File hashes

Hashes for django_wysiwyg_redactor-0.5.0-py2-none-any.whl
Algorithm Hash digest
SHA256 b4fca47e8f0db62788cd1f4c6cfb02e83de9d83b2dd710b6010a9aeab48041a1
MD5 c0dfaebe2a126118246d6427351ce6b2
BLAKE2b-256 bad5f92b401ff4ae97611d0ea3694b06f196c7223b4f4d20f55aadb044437d62

See more details on using hashes here.

Supported by

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