Screenshot
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 = EntryAdminFormRedactorEditor 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
Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am ‘Add some feature’
Push to the branch: git push origin my-new-feature
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.
1 maintainer
Metadata
1 maintainer
Release files for django-wysiwyg-redactor 0.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| django-wysiwyg-redactor-0.5.1.tar.gz | 152.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_wysiwyg_redactor-0.5.1-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 319.8 kB
Release files / django-wysiwyg-redactor-0.5.1.tar.gz
| Download URL | django-wysiwyg-redactor-0.5.1.tar.gz |
|---|---|
| Size | 152.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
03c8ecca077d191cd030a3e59144f43de901c9b855347c27c96332e6ec904736
|
|
BLAKE2b-256 checksum How to use checksums |
da9ca80ab754b0adf5484df8066b78d07fd8a3c8e35e99b38fc2f44b1838d70b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / django_wysiwyg_redactor-0.5.1-py2-none-any.whl
| Download URL | django_wysiwyg_redactor-0.5.1-py2-none-any.whl |
|---|---|
| Size | 167.8 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
f4dfa3c7e471ff8a9ec38049fdfadbd8ebc6f0b35585fd0ce596707733e66854
|
|
BLAKE2b-256 checksum How to use checksums |
b4b3c79fdf7a1cfe3c07f53e6926cf28f16896733d027df813208f83940eb7eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for django-wysiwyg-redactor 0.5.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
