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 try to use the language defined in LANGUAGE_CODE and if this language isin’t availabe the default is en

  6. (Optional) If you wish image filenames to be transliterated, install unidecode from PyPi and set:

    TRUMBOWYG_TRANSLITERATE_FILENAME = True
  7. Set [semantics](https://alex-d.github.io/Trumbowyg/documentation/#semantic) if necessary. It defaults to false:

    TRUMBOWYG_SEMANTIC = 'true'
  8. Don’t forget to add {{ form.media }} to form template.

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.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_trumbowyg-1.1.2-py3-none-any.whl (228.2 kB view details)

Uploaded Python 3

File details

Details for the file django_trumbowyg-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: django_trumbowyg-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 228.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.6

File hashes

Hashes for django_trumbowyg-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 92b39b4f98d70476cd46bdfce55edf11876cf1faa94bad3da5151ea7d9943e0e
MD5 5255bb8b401fb32decdee18fff0e0409
BLAKE2b-256 2581750a476bcf084b6cb9640db5d7b7f23c4d1c1ab56458a3d8b07883ea520d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page