From 9c6bf848ddc4a1b271f7a43715d856a4fd902c73 Mon Sep 17 00:00:00 2001 From: Andi Albrecht Date: Tue, 7 Apr 2009 19:59:40 +0200 Subject: Added long description for PyPI --- setup.py | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 67 insertions(+), 2 deletions(-) (limited to 'setup.py') diff --git a/setup.py b/setup.py index e501241..f85898f 100755 --- a/setup.py +++ b/setup.py @@ -3,16 +3,29 @@ # This setup script is part of python-sqlparse and is released under # the BSD License: http://www.opensource.org/licenses/bsd-license.php. +import os from distutils.core import setup + +def find_packages(base): + ret = [base] + for path in os.listdir(base): + if path.startswith('.'): + continue + full_path = os.path.join(base, path) + if os.path.isdir(full_path): + ret += find_packages(full_path) + return ret + + setup( name='sqlparse', version='0.1.0', - py_modules=['sqlparse'], + packages=find_packages('sqlparse'), description='Non-validating SQL parser', author='Andi Albrecht', author_email='albrecht.andi@gmail.com', - #long_description=release.long_description, + long_description=LONG_DESCRIPTION, license='BSD', url='http://python-sqlparse.googlecode.com/', classifiers = [ @@ -26,3 +39,55 @@ setup( ], scripts=['bin/sqlformat'], ) + + +LONG_DESCRIPTION = """ +``sqlparse`` is a non-validating SQL parser module. +It provides support for parsing, splitting and formatting SQL statements. + +Visit the `project page `_ for +additional information and documentation. + +**Example Usage** + + +Splitting SQL statements:: + + >>> import sqlparse + >>> sqlparse.split('select * from foo; select * from bar;') + [u'select * from foo; ', u'select * from bar;'] + + +Formatting statemtents:: + + >>> sql = 'select * from foo where id in (select id from bar);' + >>> print sqlparse.format(sql, reindent=True, keyword_case='upper') + SELECT * + FROM foo + WHERE id IN + (SELECT id + FROM bar); + + +Parsing:: + + >>> sql = 'select * from "someschema"."mytable" where id = 1' + >>> res = sqlparse.parse(sql) + >>> res + (,) + >>> stmt = res[0] + >>> stmt.to_unicode() # converting it back to unicode + u'select * from "someschema"."mytable" where id = 1' + >>> # This is how the internal representation looks like: + >>> stmt.tokens + (, + , + , + , + , + , + , + , + ) + +""" -- cgit v1.2.1