blob: 5e9c1d8e2da85e8c80f3627116173ed67f08a36b [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
46from distutils.command.build_ext import build_ext
47from distutils.errors import CCompilerError, DistutilsPlatformError
Armin Ronacherde478f62007-02-28 22:35:04 +010048
Armin Ronacher0830e252007-03-22 23:45:30 +010049
Armin Ronacherd43f9262008-07-17 23:26:14 +020050#: don't change the variable and assignment. the fabfile parses this
51#: file to get the version for deployment from it.
Armin Ronacher237cdde2008-07-17 23:34:44 +020052VERSION = '2.1'
Armin Ronacherd43f9262008-07-17 23:26:14 +020053
54
Armin Ronacher58f351d2008-05-28 21:30:14 +020055data_files = []
56documentation_path = 'docs/_build/html'
57if os.path.exists(documentation_path):
58 documentation_files = []
59 for fn in os.listdir(documentation_path):
60 if not fn.startswith('.'):
61 fn = os.path.join(documentation_path, fn)
62 if os.path.isfile(fn):
63 documentation_files.append(fn)
64 data_files.append(('docs', documentation_files))
Armin Ronachere21ced22007-03-22 23:57:10 +010065
66
Armin Ronacher203bfcb2008-04-24 21:54:44 +020067def get_terminal_width():
68 """Return the current terminal dimensions."""
69 try:
70 from struct import pack, unpack
71 from fcntl import ioctl
72 from termios import TIOCGWINSZ
73 s = pack('HHHH', 0, 0, 0, 0)
74 return unpack('HHHH', ioctl(sys.stdout.fileno(), TIOCGWINSZ, s))[1]
75 except:
76 return 80
77
78
Armin Ronacherbd33f112008-04-18 09:17:32 +020079class optional_build_ext(build_ext):
80 """This class allows C extension building to fail."""
81
82 def run(self):
83 try:
84 build_ext.run(self)
85 except DistutilsPlatformError:
86 self._unavailable()
87
88 def build_extension(self, ext):
89 try:
90 build_ext.build_extension(self, ext)
91 except CCompilerError, x:
92 self._unavailable()
93
94 def _unavailable(self):
Armin Ronacher203bfcb2008-04-24 21:54:44 +020095 width = get_terminal_width()
96 print '*' * width
Armin Ronacherbd33f112008-04-18 09:17:32 +020097 print """WARNING:
98An optional C extension could not be compiled, speedups will not be
99available."""
Armin Ronacherbd33f112008-04-18 09:17:32 +0200100
101
Armin Ronacherde478f62007-02-28 22:35:04 +0100102setup(
Armin Ronacher203bfcb2008-04-24 21:54:44 +0200103 name='Jinja2',
Armin Ronacherd43f9262008-07-17 23:26:14 +0200104 version=VERSION,
Armin Ronacher015b0c92007-11-11 00:10:17 +0100105 url='http://jinja.pocoo.org/',
106 license='BSD',
107 author='Armin Ronacher',
108 author_email='armin.ronacher@active-4.com',
109 description='A small but fast and easy to use stand-alone template '
110 'engine written in pure python.',
Armin Ronacherbd33f112008-04-18 09:17:32 +0200111 long_description=__doc__,
Armin Ronachere21ced22007-03-22 23:57:10 +0100112 # jinja is egg safe. But because we distribute the documentation
113 # in form of html and txt files it's a better idea to extract the files
Armin Ronacher015b0c92007-11-11 00:10:17 +0100114 zip_safe=False,
115 classifiers=[
Armin Ronachera9d59222008-07-18 00:41:37 +0200116 'Development Status :: 5 - Production/Stable',
Armin Ronacherde478f62007-02-28 22:35:04 +0100117 'Environment :: Web Environment',
118 'Intended Audience :: Developers',
119 'License :: OSI Approved :: BSD License',
120 'Operating System :: OS Independent',
121 'Programming Language :: Python',
Armin Ronacher8ebf1f92007-03-03 11:22:18 +0100122 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
123 'Topic :: Software Development :: Libraries :: Python Modules',
124 'Topic :: Text Processing :: Markup :: HTML'
125 ],
Armin Ronacher4a3038d2008-04-07 18:46:27 +0200126 packages=['jinja2'],
Armin Ronacher58f351d2008-05-28 21:30:14 +0200127 data_files=data_files,
Armin Ronacherbd33f112008-04-18 09:17:32 +0200128 features={
129 'speedups': Feature("optional C speed-enhancements",
130 standard=True,
131 ext_modules=[
132 Extension('jinja2._speedups', ['jinja2/_speedups.c'])
133 ]
134 )
135 },
Armin Ronacher2b60fe52008-04-21 08:23:59 +0200136 extras_require={'i18n': ['Babel>=0.8']},
Armin Ronacherf59bac22008-04-20 13:11:43 +0200137 entry_points="""
138 [babel.extractors]
Armin Ronacher7962ce72008-05-20 17:52:52 +0200139 jinja2 = jinja2.ext:babel_extract[i18n]
Armin Ronacherf59bac22008-04-20 13:11:43 +0200140 """
Armin Ronacherde478f62007-02-28 22:35:04 +0100141)