Metadata-Version: 2.1
Name: wtf-tinymce
Version: 0.1.4
Summary: TinyMCE editor extension for WTForms
Home-page: https://github.com/azsoftware/wtf-tinymce
Author: Alexander Zhygailo
Author-email: alexander777vz@gmail.com
License: GNU General Public License v3 (GPLv3)
Keywords: wtf-tinymce,wtforms,tinymce,richeditor
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Software Development :: Libraries
License-File: LICENSE

WTF TinyMCE
===========

TinyMCE editor extension for WTForms

1. Installation
---------------

Under your project environment run:

::

    $ pip install wtf-tinymce

2. Configuring
--------------

2.1. Initializing module
~~~~~~~~~~~~~~~~~~~~~~~~

Under your application initialization (e.g. app = Flask(\_\_name\_\_))
add module import and initialization:

::

    from wtf_tinymce import wtf_tinymce
    wtf_tinymce.init_app(app)

2.2. Adding template
~~~~~~~~~~~~~~~~~~~~

In your create or edit templates (or custom templates with wtforms) add
import:

::

    {% import 'wtf_tinymce/editor.html' as tinymce with context %}

and under your site footer block add template initialization like:

::

    {% block tail %}
        {{ super() }}
        {{ tinymce.init_wtf_tinymce(default_content_css='css/tinymce.css') }}
    {% endblock %}

Note: ``default_content_css`` is optional parameter with relative path
under project static folder to your custom stylesheet for editor
content.

3. Usage
--------

::

    from wtf_tinymce.forms.fields import TinyMceField

    class MyForm(Form):
        text = TinyMceField(
            'My WTF TinyMCE Field label',
            tinymce_options={'toolbar': 'bold italic | link | code'}
        )

To optional parameter ``tinymce_options`` you can add any TinyMCE options
(see official documentation https://www.tinymce.com/docs/configure/ for details.

