Welcome to textprocessor’s documentation!¶

The textprocessor module is a simple django app that allow the developper to easily enhance the content of a string.

Installation¶

Install from GitHub (PyPI will be available later)

pip install git+https://github.com/jibaku/django-textprocessor.git#egg=textprocessor

Add ‘textprocessor’ to your INSTALLED_APPS

INSTALLED_APPS = (
    'textprocessor',
)

Install the dependancies using required.txt from the root of the project if you are using a checkout. Either it’s handled by setup.py. Currently the following dependancies are needed :

markdown

Describes how to use textprocessor when it is installed and configured.

textprocessor provides various template tags that can be used to enhance the content displayed to the user.

The twitter_username looks for @username in the value passed to the filter and add the link to the given username on the Twitter.com website:

{{ content|twitter_username }}

The markdown filter convert the value passed to the filter and convert it to markdown using the markdown library:

{{ content|markdown }}