https://github.com/j0ack/flask-codemirror

Use Codemirror JS library with Flask-WTF
https://github.com/j0ack/flask-codemirror

Last synced: 6 months ago
JSON representation

Use Codemirror JS library with Flask-WTF

• Host: GitHub
• URL: https://github.com/j0ack/flask-codemirror
• Owner: j0ack
• License: gpl-3.0
• Created: 2014-11-20T10:18:03.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-11-24T09:07:25.000Z (over 1 year ago)
• Last Synced: 2024-12-04T04:33:38.558Z (7 months ago)
• Language: Python
• Homepage: http://flask-codemirror.readthedocs.org/
• Size: 76.2 KB
• Stars: 17
• Watchers: 2
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - j0ack/flask-codemirror - Use Codemirror JS library with Flask-WTF (Python)

README

        
Flask-CodeMirror

================

|version| |license|

Implementation of source code editor for Flask and Flask-WTF using CodeMirror Javascript library

Installation

------------

     $ pip install flask-codemirror

Example

-------

A simple example of how to use this module

    .. code:: python

      from flask_wtf import FlaskForm

      from flask_codemirror.fields import CodeMirrorField

      from wtforms.fields import SubmitField

      class MyForm(FlaskForm):

          source_code = CodeMirrorField(language='python', config={'lineNumbers': 'true'})

          submit = SubmitField('Submit')

The `CodeMirrorField` works exactly like a `TextAreaField`

    .. code:: python

      @app.route('/', methods = ['GET', 'POST'])

      def index():

          form = MyForm()

          if form.validate_on_submit():

              text = form.source_code.data

          return render_template('index.html', form=form)

The module needs to be initialized in the usual way and can be configured using app.config keys

    .. code:: python

      from flask import Flask

      from flask_codemirror import CodeMirror

      # mandatory

      CODEMIRROR_LANGUAGES = ['python', 'yaml', 'htmlembedded']

      WTF_CSRF_ENABLED = True

      SECRET_KEY = 'secret'

      # optional

      CODEMIRROR_THEME = '3024-day'

      CODEMIRROR_ADDONS = (

              ('ADDON_DIR','ADDON_NAME'),

      )

      app = Flask(__name__)

      app.config.from_object(__name__)

      codemirror = CodeMirror(app)

The config `CODEMIRROR_LANGUAGES` needs to be initialized to load JavaScript. It defined all the languages you want to edit with your fields.

The config `CODEMIRROR_THEME` is optional and is used to style your TextArea using css from `CodeMirror website `_.

The config `CODEMIRROR_ADDONS` is optional and can enable many cool options see `Codemirror Addons `_ for available addons.

Finally, the template needs the support JavaScript code added, by calling `codemirror.include_codemirror()` :

    .. code:: django

       

         

           {{ codemirror.include_codemirror() }}

         

         

	   

              {{ form.csrf_token }}

              {{ form.source_code }}

	      

           

         

       

The Javascript classes are imported from a CDN, there are no static files that need to be served by the application.

.. |version| image:: https://img.shields.io/pypi/v/flask-codemirror.svg

.. |license| image:: https://img.shields.io/github/license/j0ack/flask-codemirror.svg