blob: f9f447dbdc9280c14b5140bca7d0e565134de3c4 [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 Ronacher0830e252007-03-22 23:45:30 +010044import ez_setup
45ez_setup.use_setuptools()
Armin Ronacheree2c18e2007-04-20 22:39:04 +020046
Armin Ronacherbd33f112008-04-18 09:17:32 +020047from setuptools import setup, Extension, Feature
48from distutils.command.build_ext import build_ext
49from distutils.errors import CCompilerError, DistutilsPlatformError
Armin Ronacherde478f62007-02-28 22:35:04 +010050
Armin Ronacher0830e252007-03-22 23:45:30 +010051
Armin Ronacher58f351d2008-05-28 21:30:14 +020052data_files = []
53documentation_path = 'docs/_build/html'
54if os.path.exists(documentation_path):
55 documentation_files = []
56 for fn in os.listdir(documentation_path):
57 if not fn.startswith('.'):
58 fn = os.path.join(documentation_path, fn)
59 if os.path.isfile(fn):
60 documentation_files.append(fn)
61 data_files.append(('docs', documentation_files))
Armin Ronachere21ced22007-03-22 23:57:10 +010062
63
Armin Ronacher203bfcb2008-04-24 21:54:44 +020064def get_terminal_width():
65 """Return the current terminal dimensions."""
66 try:
67 from struct import pack, unpack
68 from fcntl import ioctl
69 from termios import TIOCGWINSZ
70 s = pack('HHHH', 0, 0, 0, 0)
71 return unpack('HHHH', ioctl(sys.stdout.fileno(), TIOCGWINSZ, s))[1]
72 except:
73 return 80
74
75
Armin Ronacherbd33f112008-04-18 09:17:32 +020076class optional_build_ext(build_ext):
77 """This class allows C extension building to fail."""
78
79 def run(self):
80 try:
81 build_ext.run(self)
82 except DistutilsPlatformError:
83 self._unavailable()
84
85 def build_extension(self, ext):
86 try:
87 build_ext.build_extension(self, ext)
88 except CCompilerError, x:
89 self._unavailable()
90
91 def _unavailable(self):
Armin Ronacher203bfcb2008-04-24 21:54:44 +020092 width = get_terminal_width()
93 print '*' * width
Armin Ronacherbd33f112008-04-18 09:17:32 +020094 print """WARNING:
95An optional C extension could not be compiled, speedups will not be
96available."""
Armin Ronacherbd33f112008-04-18 09:17:32 +020097
98
Armin Ronacherde478f62007-02-28 22:35:04 +010099setup(
Armin Ronacher203bfcb2008-04-24 21:54:44 +0200100 name='Jinja2',
Armin Ronacherfa5a74f2008-06-09 18:44:05 +0200101 version='2.0rc1',
Armin Ronacher015b0c92007-11-11 00:10:17 +0100102 url='http://jinja.pocoo.org/',
103 license='BSD',
104 author='Armin Ronacher',
105 author_email='armin.ronacher@active-4.com',
106 description='A small but fast and easy to use stand-alone template '
107 'engine written in pure python.',
Armin Ronacherbd33f112008-04-18 09:17:32 +0200108 long_description=__doc__,
Armin Ronachere21ced22007-03-22 23:57:10 +0100109 # jinja is egg safe. But because we distribute the documentation
110 # in form of html and txt files it's a better idea to extract the files
Armin Ronacher015b0c92007-11-11 00:10:17 +0100111 zip_safe=False,
112 classifiers=[
Armin Ronacherda5118b2008-06-09 18:46:26 +0200113 'Development Status :: 4 - Beta',
Armin Ronacherde478f62007-02-28 22:35:04 +0100114 'Environment :: Web Environment',
115 'Intended Audience :: Developers',
116 'License :: OSI Approved :: BSD License',
117 'Operating System :: OS Independent',
118 'Programming Language :: Python',
Armin Ronacher8ebf1f92007-03-03 11:22:18 +0100119 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
120 'Topic :: Software Development :: Libraries :: Python Modules',
121 'Topic :: Text Processing :: Markup :: HTML'
122 ],
Armin Ronacher4a3038d2008-04-07 18:46:27 +0200123 packages=['jinja2'],
Armin Ronacher58f351d2008-05-28 21:30:14 +0200124 data_files=data_files,
Armin Ronacherbd33f112008-04-18 09:17:32 +0200125 features={
126 'speedups': Feature("optional C speed-enhancements",
127 standard=True,
128 ext_modules=[
129 Extension('jinja2._speedups', ['jinja2/_speedups.c'])
130 ]
131 )
132 },
Armin Ronacher2b60fe52008-04-21 08:23:59 +0200133 extras_require={'i18n': ['Babel>=0.8']},
Armin Ronacherf59bac22008-04-20 13:11:43 +0200134 entry_points="""
135 [babel.extractors]
Armin Ronacher7962ce72008-05-20 17:52:52 +0200136 jinja2 = jinja2.ext:babel_extract[i18n]
Armin Ronacherf59bac22008-04-20 13:11:43 +0200137 """
Armin Ronacherde478f62007-02-28 22:35:04 +0100138)