From: Armin Ronacher <armin.ronacher@active-4.com>
Date: Thu, 22 Mar 2007 21:56:18 +0000 (+0100)
Subject: [svn] updated setup.py file for jinja 1.0 release
X-Git-Tag: 2.0rc1~401
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=69479121caa8e3188143db4517b6362d86b2420c;p=jinja2.git

[svn] updated setup.py file for jinja 1.0 release

--HG--
branch : trunk
---

diff --git a/setup.py b/setup.py
index 5c1748e..ea72437 100644
--- a/setup.py
+++ b/setup.py
@@ -1,4 +1,51 @@
 # -*- coding: utf-8 -*-
+"""
+Jinja
+=====
+
+Jinja is a `sandboxed`_ template engine written in pure Python. It provides a
+`Django`_ like non-XML syntax and compiles templates into executable python code.
+It's basically a combination of Django templates and python code.
+
+Nutshell
+--------
+
+Here a small example of a Jinja template::
+
+    {% extends 'base.html' %}
+    {% block title %}Memberlist{% endblock %}
+    {% block content %}
+      <ul>
+      {% for user in users %}
+        <li><a href="{{ user.url|e }}">{{ user.username|e }}</a></li>
+      {% endfor %}
+      </ul>
+    {% endblock %}
+
+Philosophy
+----------
+
+Application logic is for the controller but don't try to make the life for the
+template designer too hard by giving him too few functionality.
+
+For more informations visit the new `jinja webpage`_ and `documentation`_.
+
+Note
+----
+
+This is the Jinja 1.0 release which is completely incompatible with the old
+"pre 1.0" branch. The old branch will still receive security updates and
+bugfixes but the 1.0 branch will be the only version that receives support.
+
+If you have an application that uses Jinja 0.9 and won't be updated in the
+near future the best idea is to ship a Jinja 0.9 checkout together with
+the application.
+
+.. _sandboxed: http://en.wikipedia.org/wiki/Sandbox_%28computer_security%29
+.. _Django: http://www.djangoproject.com/
+.. _jinja webpage: http://jinja.pocoo.org/
+.. _documentation: http://jinja.pocoo.org/documentation/index.html
+"""
 try:
     import ez_setup
     ez_setup.use_setuptools()
@@ -6,7 +53,6 @@ except ImportError:
     pass
 from setuptools import setup
 
-
 setup(
     name = 'Jinja',
     version = '1.0',
@@ -16,6 +62,7 @@ setup(
     author_email = 'armin.ronacher@active-4.com',
     description = 'A small but fast and easy to use stand-alone template '
                   'engine written in pure python.',
+    long_description = __doc__,
     zip_safe = True,
     classifiers = [
         'Development Status :: 5 - Production/Stable',