changeset 5:6c6766109dac

adding README.txt and use it in setup.py long_description
author k0s <k0scist@gmail.com>
date Wed, 24 Feb 2010 20:21:47 -0500
parents ce757057961c
children 015875d43b91
files README.txt setup.py
diffstat 2 files changed, 30 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,23 @@
+CAPTCHA Auth Middleware
+=======================
+
+CAPTCHAauthmiddleware is a WSGI middleware python packages for putting
+CAPTCHAs on forms for unauthorized users (those that haven't logged in
+yet).  If you aren't authorized -- in python terms, if remote_user is
+not set on the request -- then CAPTCHAs and a hidden key will be added
+to forms with ``method=POST``.  You will be required to correctly
+solve the CAPTCHA in order to submit the POST request.  Otherwise, the
+CAPTCHAauthmiddleware will stop your request and redirect you back to
+the form.
+
+
+What are CAPTCHAs?  -or- I hate those things
+--------------------------------------------
+
+CAPTCHAs are admittedly imperfect ways of telling humans and computers
+apart.  Presumedly if you are already identified (logged in), then the
+computer is satisfied that you are you.  But what if you want to make
+an anonymous comment on someone's blog post?  In a perfect world,
+there would be no CAPTCHAs.  In the real world, there is SPAM.  So if
+I want to protect my blog from SPAM-bots, I need to do something.
+Again, CAPTCHAs aren't perfect, but they're at least something.
\ No newline at end of file
--- a/setup.py
+++ b/setup.py
@@ -1,18 +1,23 @@
 from setuptools import setup, find_packages
 import sys, os
 
+# read the description from the file
+try:
+    description = file(os.path.join(os.path.dirname(__file__), 'README.txt')).read()
+except:
+    description = '' 
+
 version = "0.2"
 
 setup(name='CAPTCHAmiddleware',
       version=version,
       description="put CAPTCHAs on forms",
-      long_description="""
-""",
+      long_description=description,
       classifiers=[], # Get strings from http://www.python.org/pypi?%3Aaction=list_classifiers
       author='Jeff Hammel',
       author_email='k0scist@gmail.com',
       url='http://k0s.org/hg',
       license="GPL",
       packages=find_packages(exclude=['ez_setup', 'examples', 'tests']),
       include_package_data=True,
       zip_safe=False,