JinjaLive documentation ¶

Welcome to JinjaLive documentation!

JinjaLive is a project created by Marlysys.

JinjaLive can be used to test your Jinja templates. It renders a Jinja template with given variables to a rendered output. As simple as that !

Contents

JinjaLive documentation

Installation ¶

JinjaLive is available on pip:

pip install jinjalive

Usage ¶

Command-line usage ¶

Given a context file and a template file, JinjaLive will generate the output file:

jinjalive -cf <context_file> -tf <template_file> -of <output_file>

Web application ¶

Launch the JinjaLive server with:

jinjalive-server

Open your browser to http://<your_ip_address>:8888

Tests ¶

JinjaLive embeds unittests to ensure both functionnalities coverage but also Python code quality.

The test suite can be launched with tox:

cd jinjalive
sudo pip install -r test-requirements.txt
tox

Apache configuration (optional)¶

If you want to serve the JinjaLive web application behind Apache, please use WSGI.

sudo apt-get update
sudo apt-get install apache2 libapache2-mod-wsgi
sudo a2enmod wsgi

Here is a sample Apache virtualhost:

<VirtualHost *:80>

    WSGIDaemonProcess jinjalive threads=5
    WSGIScriptAlias /jinja /usr/local/lib/python2.7/dist-packages/jinjalive/jinjalive.wsgi

    <Directory /usr/local/lib/python2.7/dist-packages/jinjalive>
        WSGIProcessGroup jinjalive
        WSGIApplicationGroup %{GLOBAL}
        WSGIScriptReloading On
        Require all granted
    </Directory>

    ErrorLog ${APACHE_LOG_DIR}/jinjalive.error.log
    CustomLog ${APACHE_LOG_DIR}/jinjalive.access.log combined

</VirtualHost>

Your JinjaLive web application is now available under http://<your_ip_address>/jinja.

Contributing ¶

Requirements ¶

JinjaLive needs the following requirements:

Python.
Bower.

Nowadays, python should ever be present on your system, but bower usually requires proper installation.

bower requires nodejs. Here is the full procedure to install bower for Ubuntu:

sudo apt-get update
sudo apt-get install nodejs npm
sudo npm install -g bower
sudo ln -s /usr/bin/nodejs /usr/bin/node

Go to project directory:

cd jinjalive

Install bower requirements:

bower install

Install Python requirements and JinjaLive package with a virtualenv:

mkvirtualenv jinjalive
pip install -r requirements.txt
python setup.py develop