Skip to main content

Trumbowyg (WYSIWYG editor) integration app for Django admin.

Project description

Introduction

django-trumbowyg is the Django-related reusable app for integrating Trumbowyg WYSIWYG editor. It is recognized as one of the best WYSIWYG editors.

Initially this package was forked from Django FS Trumbowyg package and then reworked.

Installation

  1. Install django-trumbowyg using pip:

    $ pip install django-trumbowyg
    
  2. Add 'trumbowyg' to your INSTALLED_APPS setting:

    INSTALLED_APPS = (
        ...
        'trumbowyg',
        ...
    )
    
  3. Update your urls.py:

    url(r'^trumbowyg/', include('trumbowyg.urls'))
    
  4. Sometimes you might want to limit size of uploaded images, e.g. if they are too large. In this case just put in settings (if you omit this, the image will be uploaded unchanged):

    TRUMBOWYG_THUMBNAIL_SIZE = (1920, 1080)
    
  5. The package will look for LANGUAGES setting. Please make sure you have set it otherwise ALL available language files will be loaded, and apparently this is not what you want:

    LANGUAGES = (
        ('en', 'English'),
        ('ru', 'Russian'),
    )
    
  6. (Optional) If you wish image filenames to be transliterated, install transliterate from PyPi and set:

    TRUMBOWYG_TRANSLITERATE_FILENAME = True
    

Usage

Use TrumbowygWidget in your forms:

from django.forms import ModelForm
from django.contrib.admin import ModelAdmin
from trumbowyg.widgets import TrumbowygWidget
from your_app.models import YourModel

class YourModelAdminForm(ModelForm):
    class Meta:
        model = YourModel
        widgets = {
            'text': TrumbowygWidget(),
        }

class YourModelAdmin(admin.ModelAdmin):
    form = YourModelAdminForm


admin.site.register(YourModel, YourModelAdmin)

Credits

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-trumbowyg, version 1.0.3
Filename, size File type Python version Upload date Hashes
Filename, size django_trumbowyg-1.0.3-py3-none-any.whl (116.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django_trumbowyg-1.0.3-py2-none-any.whl (116.7 kB) File type Wheel Python version py2 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page