blob: e97afcf6aa74a50a721d471ee90adaeaf5b92430 [file] [log] [blame]
Armin Ronacherde478f62007-02-28 22:35:04 +01001# -*- coding: utf-8 -*-
Armin Ronacher58293062008-02-11 15:36:22 +01002"""
Armin Ronacher203bfcb2008-04-24 21:54:44 +02003Jinja2
4~~~~~~
Armin Ronacher58293062008-02-11 15:36:22 +01005
Armin Ronacher203bfcb2008-04-24 21:54:44 +02006Jinja2 is a template engine written in pure Python. It provides a
7`Django`_ inspired non-XML syntax but supports inline expressions and
8an optional `sandboxed`_ environment.
Armin Ronacher58293062008-02-11 15:36:22 +01009
10Nutshell
11--------
12
13Here a small example of a Jinja template::
14
15 {% extends 'base.html' %}
16 {% block title %}Memberlist{% endblock %}
17 {% block content %}
18 <ul>
19 {% for user in users %}
Armin Ronacher203bfcb2008-04-24 21:54:44 +020020 <li><a href="{{ user.url }}">{{ user.username }}</a></li>
Armin Ronacher58293062008-02-11 15:36:22 +010021 {% endfor %}
22 </ul>
23 {% endblock %}
24
25Philosophy
26----------
27
28Application logic is for the controller but don't try to make the life
29for the template designer too hard by giving him too few functionality.
30
Armin Ronacherf4e1fb42008-06-09 18:54:56 +020031For more informations visit the new `Jinja2 webpage`_ and `documentation`_.
Armin Ronacher58293062008-02-11 15:36:22 +010032
Armin Ronacher203bfcb2008-04-24 21:54:44 +020033The `Jinja2 tip`_ is installable via `easy_install` with ``easy_install
34Jinja2==dev``.
Armin Ronacher58293062008-02-11 15:36:22 +010035
36.. _sandboxed: http://en.wikipedia.org/wiki/Sandbox_(computer_security)
37.. _Django: http://www.djangoproject.com/
Armin Ronacherf4e1fb42008-06-09 18:54:56 +020038.. _Jinja2 webpage: http://jinja.pocoo.org/
Armin Ronacher1a12c8a2008-06-09 18:49:14 +020039.. _documentation: http://jinja.pocoo.org/2/documentation/
40.. _Jinja2 tip: http://dev.pocoo.org/hg/jinja2-main/archive/tip.tar.gz#egg=Jinja2-dev
Armin Ronacher58293062008-02-11 15:36:22 +010041"""
Armin Ronacher0830e252007-03-22 23:45:30 +010042import os
Armin Ronacherd15a4dc2007-05-28 18:16:16 +020043import sys
Armin Ronacheree2c18e2007-04-20 22:39:04 +020044
Armin Ronacherbd33f112008-04-18 09:17:32 +020045from setuptools import setup, Extension, Feature
Armin Ronacherde478f62007-02-28 22:35:04 +010046
Armin Ronacher0faa8612010-02-09 15:04:51 +010047# tell distribute to use 2to3 with our own fixers.
48extra = {}
49if sys.version_info >= (3, 0):
50 extra.update(
51 use_2to3=True,
52 use_2to3_fixers=['custom_fixers']
53 )
Armin Ronacher0319c662010-02-09 02:09:10 +010054
Armin Ronacher0830e252007-03-22 23:45:30 +010055
Armin Ronacherde478f62007-02-28 22:35:04 +010056setup(
Armin Ronacher203bfcb2008-04-24 21:54:44 +020057 name='Jinja2',
Armin Ronacherb4804182010-06-05 14:41:55 +020058 version='2.6',
Armin Ronacher015b0c92007-11-11 00:10:17 +010059 url='http://jinja.pocoo.org/',
60 license='BSD',
61 author='Armin Ronacher',
62 author_email='armin.ronacher@active-4.com',
63 description='A small but fast and easy to use stand-alone template '
64 'engine written in pure python.',
Armin Ronacherbd33f112008-04-18 09:17:32 +020065 long_description=__doc__,
Armin Ronacher86b5cb52009-09-13 00:23:27 -070066 # jinja is egg safe. But we hate eggs
Armin Ronacher015b0c92007-11-11 00:10:17 +010067 zip_safe=False,
68 classifiers=[
Armin Ronachera9d59222008-07-18 00:41:37 +020069 'Development Status :: 5 - Production/Stable',
Armin Ronacherde478f62007-02-28 22:35:04 +010070 'Environment :: Web Environment',
71 'Intended Audience :: Developers',
72 'License :: OSI Approved :: BSD License',
73 'Operating System :: OS Independent',
74 'Programming Language :: Python',
Armin Ronacherd9599c82010-02-10 02:19:17 +010075 'Programming Language :: Python :: 3',
Armin Ronacher8ebf1f92007-03-03 11:22:18 +010076 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
77 'Topic :: Software Development :: Libraries :: Python Modules',
78 'Topic :: Text Processing :: Markup :: HTML'
79 ],
Armin Ronacher644a2812010-02-09 18:06:32 +010080 packages=['jinja2', 'jinja2.testsuite', 'jinja2.testsuite.res'],
Armin Ronacherbd33f112008-04-18 09:17:32 +020081 features={
82 'speedups': Feature("optional C speed-enhancements",
Armin Ronacher9ebc4572009-09-13 00:30:06 -070083 standard=False,
Armin Ronacherbd33f112008-04-18 09:17:32 +020084 ext_modules=[
85 Extension('jinja2._speedups', ['jinja2/_speedups.c'])
86 ]
87 )
88 },
Armin Ronacher2b60fe52008-04-21 08:23:59 +020089 extras_require={'i18n': ['Babel>=0.8']},
Armin Ronacher7af781c2010-02-09 16:05:08 +010090 test_suite='jinja2.testsuite.suite',
Armin Ronacher790b8a82010-02-10 00:05:46 +010091 include_package_data=True,
Armin Ronacherf59bac22008-04-20 13:11:43 +020092 entry_points="""
93 [babel.extractors]
Armin Ronacher7962ce72008-05-20 17:52:52 +020094 jinja2 = jinja2.ext:babel_extract[i18n]
Armin Ronacher0319c662010-02-09 02:09:10 +010095 """,
Armin Ronacher0faa8612010-02-09 15:04:51 +010096 **extra
Armin Ronacherde478f62007-02-28 22:35:04 +010097)