Integrate Quill editor with Django project.

Project description

django-quill-editor

django-quill-editor makes Quill.js easy to use on Django Forms and admin sites

No configuration required for static files!
The entire code for inserting WYSIWYG editor is less than 30 lines
It can be used in both admin and Django views

django-quill-editor

Setup

Install django-quill-editor to your Python environment
```
pip install django-quill-editor
```

Add django_quill to INSTALLED_APPS in settings.py

# settings.py
INSTALLED_APPS = [
    'django.contrib.admin',
    ...
    'django_quill',
]

Run Sample project

Repo: django-quill-editor-sample

# Clone repo
git clone https://github.com/LeeHanYeong/django-quill-editor-sample
cd django-quill-editor-sample

# Create virtualenv (I used pyenv, but you can use other methods)
pyenv virtualenv 3.7.5 django-quill
pyenv local django-quill

# Install Python packages
pip install -r requirements.txt
python app/manage.py runserver

Documentation

Documentation for django-quill-editor is located at https://django-quill-editor.readthedocs.io/

Change toolbar configs

Add QUILL_CONFIGS to the settings.py

QUILL_CONFIGS = {
    'default':{
        'theme': 'snow',
        'modules': {
            'syntax': True,
            'toolbar': [
                [
                    {'font': []},
                    {'header': []},
                    {'align': []},
                    'bold', 'italic', 'underline', 'strike', 'blockquote',
                    {'color': []},
                    {'background': []},
                ],
                ['code-block', 'link'],
                ['clean'],
            ]
        }
    }
}

Usage

Add QuillField to the Model class you want to use

# models.py
from django.db import models
from django_quill.fields import QuillField

class QuillPost(models.Model):
    content = QuillField()

1. Django admin

Just register the Model in admin.py of the app.

from django.contrib import admin
from .models import QuillPost

@admin.register(QuillPost)
class QuillPostAdmin(admin.ModelAdmin):
    pass

admin-sample

2. Form

Add QuillFormField to the Form class you want to use
There are two ways to add CSS and JS files to a template.
- If there is a Form with QuillField added, add {{ form.media }} to the <head> tag.
```
<head>
    {{ form.media }}
</head>
```
- Or, import CSS and JS files directly using {% include %} template tags.
```
<head>
    
    {% include 'django_quill/media.html' %}
</head>
```

# forms.py
from django import forms
from django_quill.forms import QuillFormField

class QuillFieldForm(forms.Form):
    content = QuillFormField()

# views.py
from django.shortcuts import render
from .forms import QuillFieldForm

def form(request):
    return render(request, 'form.html', {'form': QuillFieldForm()})

<!-- Template -->
<form action="" method="POST">{% csrf_token %}
    {{ form.content }}
</form>

3. ModelForm

Just define and use ModelForm of Model class

# forms.py
from django import forms
from .models import QuillPost

class QuillPostForm(forms.ModelForm):
    class Meta:
        model = QuillPost
        fields = (
            'content',
        )

# views.py
from django.shortcuts import render
from .forms import QuillPostForm

def model_form(request):
    return render(request, 'model_form.html', {'form': QuillPostForm()})

<!-- Template -->
<form action="" method="POST">{% csrf_token %}
    {{ form.content }}
</form>

Form, ModelForm's Output:

form-sample

Contributing

As an open source project, we welcome contributions. The code lives on GitHub

Distribution (for owners)

PyPI Release

poetry install  # Install PyPI distribution packages
python deploy.py

Sphinx docs

brew install sphinx-doc  # macOS

Local

cd docs
make html
# ...
# The HTML pages are in _build/html.

cd _build/html
python -m http.server 3001

Project details

Development Status
- 4 - Beta
Framework
Programming Language

Release history Release notifications | RSS feed

0.1.22

Mar 23, 2021

0.1.21

Feb 27, 2021

0.1.19

Feb 10, 2021

0.1.18

Feb 9, 2021

This version

0.1.16

Aug 20, 2020

0.1.15

Aug 13, 2020

0.1.14

Aug 4, 2020

0.1.13

Aug 4, 2020

0.1.12

Jun 25, 2020

0.1.11

Jun 25, 2020

0.1.10

Jun 9, 2020

0.1.9

Jun 9, 2020

0.1.8

Jun 9, 2020

0.1.7

Jun 9, 2020

0.1.6

Jun 9, 2020

0.1.5

Mar 20, 2020

0.1.4

Mar 19, 2020

0.1.3

Mar 17, 2020

0.1.2

Mar 5, 2020

Download files

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

Files for django-quill-editor, version 0.1.16
Filename, size	File type	Python version	Upload date	Hashes
Filename, size django_quill_editor-0.1.16-py3-none-any.whl (463.8 kB)	File type Wheel	Python version py3	Upload date Aug 20, 2020	Hashes View
Filename, size django-quill-editor-0.1.16.tar.gz (8.1 kB)	File type Source	Python version None	Upload date Aug 20, 2020	Hashes View

Hashes for django_quill_editor-0.1.16-py3-none-any.whl

Hashes for django_quill_editor-0.1.16-py3-none-any.whl
Algorithm	Hash digest
SHA256	`5c91886caa345802c21430ea7b0523d8081b494c6d3ecf312a91917922bc2fea`
MD5	`5dbaae1acfdc515d8ac7539d969dca4a`
BLAKE2-256	`1e393ec2c7a9c9f83db92eef8c37fc89444311de64cf5bd4573da48f15c4f2a1`

Hashes for django-quill-editor-0.1.16.tar.gz

Hashes for django-quill-editor-0.1.16.tar.gz
Algorithm	Hash digest
SHA256	`d1511622ba78810806516a14899d6819b4b2f4e1c6536e652221bb711e66ebc6`
MD5	`c62481033d61e94be044e50a1246f06d`
BLAKE2-256	`e33723067cf5267ee26f6a9788bca0e60c552c77b7cb3495a8d4a9a15b7b6816`