summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAndi Albrecht <albrecht.andi@gmail.com>2009-04-03 21:26:42 +0200
committerAndi Albrecht <albrecht.andi@gmail.com>2009-04-03 21:26:42 +0200
commit361122eb22d5681c58dac731009e4814b3dd5fa5 (patch)
treeb096496bc9c6b8febe092d0aefd56de1a4f8f4a0 /README
downloadsqlparse-361122eb22d5681c58dac731009e4814b3dd5fa5.tar.gz
Initial import.
Diffstat (limited to 'README')
-rw-r--r--README45
1 files changed, 45 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..10c8c1a
--- /dev/null
+++ b/README
@@ -0,0 +1,45 @@
+python-sqlparse - Parse SQL statements
+======================================
+
+sqlparse currently support only one feature: You can split a series
+of SQL statements into single statements.
+
+Parts of the code are based on pygments written by Georg Brandl and others.
+pygments-Homepage: http://pygments.org/
+
+Run Tests
+---------
+
+ python test/run_tests.py
+
+
+Create Documentation
+--------------------
+
+You need `Sphinx`_ installed on your system to build the documentation.
+
+ cd docs/
+ make html
+
+
+Install
+-------
+
+Run
+
+ python setup.py install
+
+with root privileges to install python-sqlparse on your system.
+
+
+Links
+-----
+
+Source code: http://github.com/andialbrecht/python-sqlparse
+
+
+python-sqlparse is licensed under the BSD license:
+http://github.com/andialbrecht/python-sqlparse
+
+
+.. _Sphinx: http://sphinx.pocoo.org/