echofun / django

A wrapper of Django's template engine for Express.js

##django

A wrapper of Django's template engine for Express.js.It's designed only for development on web front-end side.DO NOT use it for production.

Django's template syntax is quite different from twig,jinja2 or swig.For now,there is no replacement like django.js can simulate the syntax and the interfaces.But we can make Django itself working with node.js,even Express.js.So a wrapper is required.

I setup a node-python bridge through standard in/out stream.It can handle with any size of mock data or source template file theoretically.The shell script below shows how it works:

#echo '{"name":"django"}' | python django.py ./templates index.html

##install

First you have to install Django framework, pip or easy_install is recommended:

# pip install -v Django==1.7
//or
# easy_install "Django==1.7"

Make sure it's installed successfully.

Set django as a template engine for Express.js:

var express = require('express');
var path = require('path');
var django = require('django');

django.configure({
    template_dirs: path.join(__dirname, 'template')
});

var app = express();

app.engine('html', django.renderFile);
app.set('views', path.join(__dirname, 'template'));
app.set('view engine', 'html');

##API

######1.configure(configurations)

• param configurations: [Object][Required] the configurations object
• since 0.1.0
• return this

Set the configurations.It should be called at first.

######2.renderFile(tpl, data, callback)

• param tpl: [String][Required] template file name
• param data: [Object][Optional] plain object to render a template
• param callback: [Function][Required] render callback function
• since 0.1.0
• return undefined

Render a template file with data.

######3.render(source, data, callback)

• param source: [String][Required] template source codes
• param data: [Object][Optional] plain object to render a template
• param callback: [Function][Required] render callback function
• since 0.4.0
• return undefined

Render a block of source codes with data.

##configurations All the following configurations should be set by configure function.

######1.template_dirs

• Type: [String]
• Default: 'templates'

The root directory of the template files,this is necessary when templates extend or include.It could be an array in the future.

##notice

• only utf8 encoding is supported

##author

• [email protected]

##licence MIT