---
id: django-summernote
version: "0.8.20.0"
license: unclear
license_treatment: permissive
maintenance: dormant
---

# django-summernote — Summernote plugin for Django

License: permissive · Maintenance: dormant · Downloads: 120.3K/mo

## What it is and what it does

django-summernote wraps the Summernote JavaScript editor for use in Django projects, allowing developers to add rich-text editing fields to admin interfaces and forms without writing custom JavaScript. It integrates as a Django app with admin mixins and form widgets, supporting file attachments, multiple Bootstrap themes (bs3, bs4, bs5, or lite), and extensive customization through settings.

The package handles the editor's lifecycle—initialization, toolbar configuration, language settings, and attachment storage—through Django's standard patterns. It includes security-conscious form fields (SummernoteTextField, SummernoteTextFormField) that sanitize HTML using mozilla's bleach library to prevent injection attacks. Setup involves adding the app to INSTALLED_APPS, including its URLs, running migrations, and collecting static files.

Use it for:

- Add a rich-text editor to Django admin for blog post or article content fields
- Build a custom form with inline HTML editing for user-generated content
- Enable image and file uploads alongside text editing in admin interfaces
- Customize editor toolbar and appearance to match your application's design theme
- Sanitize and safely display user-submitted HTML content with bleach integration

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Embeds the Summernote WYSIWYG editor into Django admin and forms, providing rich-text editing with support for attachments and customizable themes.

Yes, with caution on maintenance. The package is stable and permissively licensed, with no known vulnerabilities and straightforward Django integration. However, it has been dormant since 2021-10-14—verify compatibility with your Django version before committing. Suitable for projects that need a proven, low-dependency rich-text solution and can tolerate potential lag in upstream updates.

## Install

pip install django-summernote
uv add django-summernote
poetry add django-summernote

## Installing django-summernote

Before you install: High install friction due to tarball distribution. Package is dormant—last release was 2021-10-14, over 1765 days ago, though the repository remains active with 1087 stars and a recent commit in 2024-06-07. No runtime dependencies simplifies setup but maintenance lag may affect Django compatibility.

License in practice: MIT license (permissive) allows commercial and private use with minimal restrictions.

Quickstart:

pip install django-summernote

# In settings.py:
INSTALLED_APPS += ('django_summernote',)

# In urls.py:
from django.urls import include
urlpatterns = [path('summernote/', include('django_summernote.urls'))]

# In admin.py:
from django_summernote.admin import SummernoteModelAdmin
class MyModelAdmin(SummernoteModelAdmin):
    summernote_fields = '__all__'
admin.site.register(MyModel, MyModelAdmin)

Requires Django installation and database migration (python manage.py migrate). MEDIA_URL and MEDIA_ROOT must be configured for attachment uploads.

Verify before relying:

- Compatibility with Django versions released after 2021-10-14 (latest release date)
- Whether high install friction is due to build requirements or packaging format only

## Package facts

- License: not declared (permissive)
- Python support: unspecified
- Install friction: high
- Maintenance: dormant
- Downloads: 120.3K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

django wysiwyg editor, rich text editor django, summernote django integration, django admin text editor, django form rich text widget, django-admin, wysiwyg-editor, form-widget

[View on SkillFed](https://skillfed.io/packages/django-summernote) · [View on PyPI](https://pypi.org/project/django-summernote/)