Skip to main content

Textile parsing from within Flask

Project description

The Python port of Dean Allen's humane web text generator packaged for use with Flask.

pip install flask-textile

Import into our project:

from flask_textile import Textile

And then...

app = Flask(__name__)
textile = Textile(app)

Or, if one prefers, with an application factory:

textile = Textile()

def create_app(config_class=Config):
    app = Flask(__name__)
    app.config.from_object(config_class)
    textile.init_app(app)
    #...

Simple usage within a Jinja2 template:

{{ text|textile }}

Or use as a filter:

{% filter textile %}
h2. Textile

* is a _shorthand syntax_ used to generate valid HTML
* is *easy* to read and *easy* to write
* can generate complex pages, including: headings, quotes, lists, tables and figures

Textile integrations are available for "a wide range of platforms":/article/.
{% endfilter %}

Additionally, Flask-Textile offers a static method, parse(), which returns a raw HTML sting from Textile input—i.e. the direct output of python-textile. (Useful for working with Textile outside of a template):

from flask_textile import Textile
Textile.parse('_Emphasized_ or *Strong* text')

# Or if you already have an instance laying around...
app = Flask(__name__)
textile = Textile(app)
#...
textile.parse('"We *adore* _Textile_":https://en.wikipedia.org/wiki/Textile_(markup_language)')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-Textile-0.4.0.tar.gz (2.4 kB view hashes)

Uploaded Source

Built Distribution

Flask_Textile-0.4.0-py3-none-any.whl (3.4 kB view hashes)

Uploaded Python 3

Supported by

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