Skip to main content

This package marries Django with CodeMirror

Project description

This package marries Django with CodeMirror. It provides (1) a customisable form widget, and (2) a shorthand way to use this widget in the admin. In both cases the relevant static files (including mode/theme/addon files) are automatically included as form assets.


This is a Python 3 package with no other dependencies apart from Django and it is offered at the Cheese Shop:

# usually inside a virtual environment
pip install django-mirror

The CodeMirror files (version 5.58.3) are included in the package. The supported Django versions are 2.2, 3.0, and 3.1.


# add 'django_mirror' to your INSTALLED_APPS if you want the package to be
# handled by Django's collectstatic command
INSTALLED_APPS += ['django_mirror']

# use DJANGO_MIRROR_DEFAULTS to specify default options for your widgets
# see the next section for more info about the options
    'mode': 'rst',
    'addons': ['mode/overlay'],
    'line_wrapping': True,


Bascially this package provides a form widget called MirrorArea that extends Django’s Textarea widget.

from django import forms
from django_mirror.widgets import MirrorArea

class CommentForm(forms.Form):
    text = forms.CharField(
            attrs={'rows': 20},  # the parent class' attrs still works
            mode='markdown',  # the other kwargs are forwarded to CodeMirror

The MirrorArea widget can be initialised with the following arguments:

  • Any of CodeMirror’s config options. These can be specified in either camelCase or snake_case (e.g. both tabSize and tab_size would work). The css/js files associated with the mode, if provided, are included as form assets.
  • addons, a list of CodeMirror addons, e.g. dialog/dialog. The css/js files associated with the addons are recursively included as form assets.
  • attrs, just as Django’s form widgets.

The addons and config options are merged with and override DJANGO_MIRROR_DEFAULTS if the setting has been defined.


If you want to use the widget in the admin panel, you can subclass the MirrorAdmin mixin, which provides the mirror_fields model admin option:

from django.contrib import admin
from django_mirror.admin import MirrorAdmin

from weblog.models import Comment

class CommentAdmin(MirrorAdmin, admin.ModelAdmin):
    mirror_fields = ('comment',)  # default options
    mirror_fields = (  # with custom options
        ('comment', {
            'mode': 'markdown',
            'line_wrapping': True,

The mixin also includes a bit of css to make CodeMirror look more like regular admin textarea fields.

similar projects

There are several other packages that provide customisable CodeMirror widgets:


GNU LGPLv3. Please refer to COPYING for the base GPLv3 licence and to COPYING.LESSER for the additional permissions on top that constitute LGPLv3.

Project details

Download files

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

Files for django-mirror, version 0.1.10
Filename, size File type Python version Upload date Hashes
Filename, size django_mirror-0.1.10-py3-none-any.whl (763.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-mirror-0.1.10.tar.gz (583.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page