# HG changeset patch
# User Jeff Hammel <k0scist@gmail.com>
# Date 1268235911 18000
# Node ID 55578cf505ddda4d757ca9008b79642e5b63bdb3
# Parent  af82aaec0377496d4f18831c4f0c4a4dc18eeabb
add some documentation for redirector

diff -r af82aaec0377 -r 55578cf505dd README.txt
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Wed Mar 10 10:45:11 2010 -0500
@@ -0,0 +1,48 @@
+redirector
+==========
+
+*Control redirects through WSGI middleware.*
+
+redirector is a piece of WSGI middleware that allows redirects to be
+managed within the scope of a python web service.  Traditionally,
+redirects are done via Apache or some other web server disparate from
+the python application.  This leads to several undesirable
+consequences:
+
+ * there is no way of controlling redirects through the web
+ * the web server must be restarted when redirects are changed
+
+Because of this methodology of doing things, it discourages the
+stake-holders (the people that actually care about the redirects) from
+changing the redirects themselves.  Because the redirects are not, in
+their mind, content, this leads to unmaintainable systems.  The goal
+of redirector is to bring the power to create redirects to any
+authorized user.
+
+
+Status
+------
+
+Redirector is largely in the conceptual stage.  While what redirector
+does now (regular expression redirects) is sufficient to reproduce
+Apache's behavior, it is not enough to realize the vision of bringing
+redirects to the people for WSGI apps.  
+
+Even this documentation is thoroughly imcomplete.
+
+
+TODO
+----
+
+redirector needs several pieces to become what it should be:
+
+Types of Redirects
+------------------
+
+Currently, only regular expression redirects (a la Apache) are
+implemented. Another possibility, probably more applicable, are
+something like glob redirects.  The reason that these are useful is
+that they, with a carefully constructed rule system, can be seen to
+match each other.  In other words, you can see if the existing set of
+redirects is contradictory and if there are superfluous redirects.  It
+also better matches how non-experts think about redirects.
diff -r af82aaec0377 -r 55578cf505dd setup.py
--- a/setup.py	Mon Sep 07 15:15:48 2009 -0400
+++ b/setup.py	Wed Mar 10 10:45:11 2010 -0500
@@ -1,18 +1,24 @@
 from setuptools import setup, find_packages
 import sys, os
 
-version = "0.1"
+# get the description from the README
+try:
+    filename = os.path.join(os.path.dirname(__file__), 'README.txt')
+    description = file(filename).read()
+except:
+    description = ''
+
+version = "0.1.1"
 
 setup(name='redirector',
       version=version,
       description="WSGI middleware/app for managing redirects",
-      long_description="""
-""",
+      long_description=description,
       classifiers=[], # Get strings from http://www.python.org/pypi?%3Aaction=list_classifiers
       author='Jeff Hammel',
-      author_email='jhammel@openplans.org',
-      url='http://k0s.org',
-      license="",
+      author_email='k0scist@gmail.com',
+      url='http://k0s.org/hg/redirector',
+      license="GPL",
       packages=find_packages(exclude=['ez_setup', 'examples', 'tests']),
       include_package_data=True,
       zip_safe=False,