PyJade is a high performance port of Jade-lang for python, that converts any .jade source to the each Template-language (Django, Jinja2, Mako or Tornado).
To simply output the conversion to your console:
pyjade [-c django|jinja|mako|tornado] input.jade [output.html]or, alternatively:
pyjade [-c django|jinja|mako|tornado] [-o output.html] < input.jadeTo convert directly inside a python script:
import pyjade
jade_text = '''!!! 5
html
head
body foo bar!
'''
print pyjade.simple_convert(jade_text)
First, you must do:
pip install pyjadeOr:
python setup.py installNow simply name your templates with a .jade extension and this jade compiler
will do the rest. Any templates with other extensions will not be compiled
with the pyjade compiler.
For Django 1.8 and above:
In settings.py, add a loader to TEMPLATES like so:
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
'django.core.context_processors.request'
],
'loaders': [
# PyJade part: ##############################
('pyjade.ext.django.Loader', (
'django.template.loaders.filesystem.Loader',
'django.template.loaders.app_directories.Loader',
))
]
},
},
]Or, in Django 1.7 or earlier:
In settings.py, modify TEMPLATE_LOADERS like:
TEMPLATE_LOADERS = (
('pyjade.ext.django.Loader',(
'django.template.loaders.filesystem.Loader',
'django.template.loaders.app_directories.Loader',
)),
)Just add pyjade.ext.jinja.PyJadeExtension as extension:
jinja_env = Environment(extensions=['pyjade.ext.jinja.PyJadeExtension'])Just add pyjade.ext.mako.preprocessor as preprocessor:
from pyjade.ext.mako import preprocessor as mako_preprocessor
mako.template.Template(jade_source,
preprocessor=mako_preprocessor
)Just add pyjade.ext.jinja.PyJadeExtension as extension to the environment of the app::
app.jinja_env.add_extension('pyjade.ext.jinja.PyJadeExtension')Adjust your "your_project/init.py" and add the following line somewhere to in the main() function:
config.include('pyjade.ext.pyramid')Append this after importing tornado.template
from tornado import template
from pyjade.ext.tornado import patch_tornado
patch_tornado()
(...)Exactly the same as the Jade Node.js module (except of cases, which are not implemented) https://github.com/visionmedia/jade/blob/master/README.md
This code:
!!! 5
html(lang="en")
head
title= pageTitle
script(type='text/javascript').
if (foo) {
bar()
}
body
h1.title Jade - node template engine
#container
if youAreUsingJade
p You are amazing
else
p Get on it!Converts to:
<!DOCTYPE html>
<html lang="en">
<head>
<title>{{pageTitle}}</title>
<script type='text/javascript'>
if (foo) {
bar()
}
</script>
</head>
<body>
<h1 class="title">Jade - node template engine</h1>
<div id="container">
{%if youAreUsingJade%}
<p>You are amazing</p>
{%else%}
<p>Get on it!</p>
{%endif%}
</div>
</body>
</html>If you want to register a function as a filter, you only have to
decorate the function with pyjade.register_filter("filter_name")
import pyjade
@pyjade.register_filter('capitalize')
def capitalize(text,ast):
return text.capitalize()Using Django and crispy-forms as an illustrative example but the information can be generalized.
If you need to use templatetags, you can use Jade's syntax for rendering code:
- load crispy_forms_tags
- crispy formThis will compile into
{% load crispy_forms_tags %}
{% crispy form %}If you have any trouble with this feature, or there's some feature of your template language that is being misinterpreted when using this syntax, you can also do something like this:
| {% load crispy_forms_tags %}
| {% crispy form %}This will compile into the same Django template snippet.
You must have nose package installed.
You can do the tests with
./test.sh