django-editor

Django-editor

.. image:: https://secure.travis-ci.org/littlepea/django-editor.png :target: http://travis-ci.org/littlepea/django-editor

Allows pluggable WYSIWYG editors in django admin without hard dependencies.

Currently supported editors (both optional):

• django-imperavi_
• django-tinycme_

Installation

1. Install with pip::

   pip install django-editor

2. (optional) Add imperavi or tinymce to your INSTALLED_APPS in settings.py::

   INSTALLED_APPS = ( ... # Imperavi (or tinymce) rich text editor is optional 'imperavi', )

Usage

editor package gives you the following replacement classes:

• django.forms.widgets.Textarea => editor.EditorWidget (becomes ImperaviWidget or TinyMCE)
• django.contrib.admin.ModelAdmin => editor.EditorAdmin (becomes ImperaviAdmin or stays as ModelAdmin)
• django.contrib.admin.StackedInline => editor.EditorStackedInline (becomes ImperaviStackedInline or stays as StackedInline)

Here are some examples on how to easily turn your Textareas into WYSIWYG editors::

# admin.py
from django.db import models
from django.contrib import admin
from editor.admin import EditorAdmin, EditorWidget, EditorStackedInline


class MyInlineAdmin(EditorStackedInline): # StackedInline example
    model = Model1


class MyModel2Admin(EditorAdmin): # ModelAdmin example
    inlines = [MyInlineAdmin]

admin.site.register(Model2, MyModel2Admin)


class MyModel3Admin(admin.ModelAdmin):
    formfield_overrides = {
        models.TextField: {'widget': EditorWidget},
    }

admin.site.register(Model3, MyModel3Admin)

Credits

• django-imperavi_
• django-tinycme_
• modern-package-template_
• django-newsletter_ for providing pluggable editor code idea

.. _modern-package-template: http://pypi.python.org/pypi/modern-package-template .. _django-imperavi: https://github.com/vasyabigi/django-imperavi .. _django-tinycme: https://github.com/aljosa/django-tinymce .. _django-newsletter: https://github.com/dokterbob/django-newsletter

.. This is your project NEWS file which will contain the release notes. .. Example: http://www.python.org/download/releases/2.6/NEWS.txt .. The content of this file, along with README.rst, will appear in your .. project's PyPI page.

News

0.2a1

Release date: UNRELEASED

• Working on more editors. Stay tuned...

0.1

Release date: 19-Mar-2013

• Initial release
• Supports django-imperavi and django-tinycme
• 3 admin classes: EditorAdmin, EditorWidget, EditorStackedInline
• Test coverage