Jingo is an adapter for using Jinja2 templates within Django.

When configured properly (see Settings below) you can render Jinja2 templates in your view the same way you'd render Django templates:

from django.shortcuts import render


def MyView(request):
    # TODO: Do something.
    context = dict(user_ids=[1, 2, 3, 4])
    render('users/search.html', context)

..note:

Not only does ``django.shorcuts.render`` work, but so does any method that
Django provides to render templates.

You'll want to use Django to use jingo's template loader. In settings.py:

TEMPLATE_LOADERS = (
    'jingo.Loader',
    'django.template.loaders.filesystem.Loader',
    'django.template.loaders.app_directories.Loader',
)

This will let you use django.shortcuts.render or django.shortcuts.render_to_response.

And finally you may have apps that do not use Jinja2, these must be excluded from the loader:

JINGO_EXCLUDE_APPS = ('debug_toolbar',)

If a template path begins with debug_toolbar, the Jinja loader will raise a TemplateDoesNotExist exception. This causes Django to move onto the next loader in TEMPLATE_LOADERS to find a template - in this case, django.template.loaders.filesystem.Loader.

The default is in jingo.EXCLUDE_APPS:

EXCLUDE_APPS = (
    'admin',
    'admindocs',
    'registration'
)

If you want to configure the Jinja environment, use JINJA_CONFIG in settings.py. It can be a dict or a function that returns a dict. :

JINJA_CONFIG = {'autoescape': False}

or :

def JINJA_CONFIG():
    return {'the_answer': 41 + 1}

Instead of template tags, Jinja encourages you to add functions and filters to the templating environment. In jingo, we call these helpers. When the Jinja environment is initialized, jingo will try to open a helpers.py file from every app in INSTALLED_APPS. Two decorators are provided to ease the environment extension:

Helpers are available in all templates automatically, without any extra loading.

A single Jinja Environment is created for use in all templates. This is available as jingo.env if you need to work with the Environment.

Since we all love L10n, let's see what it looks like in Jinja templates:

<h2>{{ _('Reviews for {0}')|f(addon.name) }}</h2>

The simple way is to use the familiar underscore and string within a {{ }} moustache block. f is an interpolation filter documented below. Sphinx could create a link if I knew how to do that.

The other method uses Jinja's trans tag:

{% trans user=review.user|user_link, date=review.created|datetime %}
  by {{ user }} on {{ date }}
{% endtrans %}

trans is nice when you have a lot of text or want to inject some variables directly. Both methods are useful, pick the one that makes you happy.

Django marks its form HTML "safe" according to its own rules, which Jinja2 does not recognize.

Testing is handle via fabric:

fab test