Initial import.

6 files changed, 339 insertions, 0 deletions

diff --git a/docs/source/api.rst b/docs/source/api.rst
new file mode 100644
index 0000000..3bce389
--- /dev/null
+++ b/docs/source/api.rst
@@ -0,0 +1,12 @@
+:mod:`sqlparse` -- Parse SQL statements
+=======================================
+
+The :mod:`sqlparse` module provides the following functions on module-level.
+
+.. autofunction:: sqlparse.split
+
+.. autofunction:: sqlparse.format
+
+.. autofunction:: sqlparse.parse
+
+
diff --git a/docs/source/changes.rst b/docs/source/changes.rst
new file mode 100644
index 0000000..5811c57
--- /dev/null
+++ b/docs/source/changes.rst
@@ -0,0 +1,7 @@
+.. _changes:
+
+Changes in python-sqlparse
+==========================
+
+.. include:: ../../CHANGES
+
diff --git a/docs/source/cmdline.rst b/docs/source/cmdline.rst
new file mode 100644
index 0000000..93a35a7
--- /dev/null
+++ b/docs/source/cmdline.rst
@@ -0,0 +1,8 @@
+``sqlformat`` -- Command Line Script
+===========================================
+
+The :mod:`sqlparse` module is shipped with the script
+:program:`sqlformat` which provides a command line interface to the formatting
+functions.
+
+.. todo:: Describe options and example usage.
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..b84245a
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+#
+# python-sqlparse documentation build configuration file, created by
+# sphinx-quickstart on Thu Feb 26 08:19:28 2009.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
+sys.path.append(os.path.abspath('../../'))
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage',
+              'sphinx.ext.autosummary']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'python-sqlparse'
+copyright = u'2009, Andi Albrecht'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'sphinxdoc'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = [os.path.abspath('../')]
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'python-sqlparsedoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'python-sqlparse.tex', ur'python-sqlparse Documentation',
+   ur'Andi Albrecht', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+todo_include_todos = True
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..40e99e0
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,26 @@
+.. python-sqlparse documentation master file, created by
+   sphinx-quickstart on Thu Feb 26 08:19:28 2009.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to python-sqlparse's documentation!
+===========================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   intro
+   api
+   cmdline
+   changes
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/docs/source/intro.rst b/docs/source/intro.rst
new file mode 100644
index 0000000..3d7a888
--- /dev/null
+++ b/docs/source/intro.rst
@@ -0,0 +1,89 @@
+Introduction
+============
+
+:mod:`sqlparse` is a non-validating SQL parser for Python.
+
+It provides support for parsing, splitting and formatting SQL statements.
+
+:mod:`sqlparse` is released under the terms of the
+`New BSD license <http://www.opensource.org/licenses/bsd-license.php>`_.
+
+Visit http://sqlformat.appspot.com to try it's formatting features.
+
+
+Download & Installation
+-----------------------
+
+To download and install :mod:`sqlparse` on your system run the following
+commands:
+
+.. code-block:: bash
+
+  $ git clone git://github.com/andialbrecht/python-sqlparse.git
+  $ cd python-sqlparse.git/
+  $ sudo python setup.py install
+
+A tarball of the current sources is available under the following URL:
+http://github.com/andialbrecht/python-sqlparse/tarball/master
+
+
+Example Usage
+-------------
+
+Here are some usage examples of this module.
+
+Splitting statements::
+
+  >>> import sqlparse
+  >>> sql = 'select * from foo; select * from bar;'
+  >>> sqlparse.split(sql)
+  <<< [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);
+
+Now, let's have a deeper look at the internals::
+
+  >>> sql = 'select * from "someschema"."mytable" where id = 1'
+  >>> pared = sqlparse.parse(sql)
+  >>> pared
+  <<< (<Statement 'select...' at 0x9ad08ec>,)
+  >>> stmt = parsed[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
+  <<<
+  (<DML 'select' at 0x9b63c34>,
+   <Whitespace ' ' at 0x9b63e8c>,
+   <Operator '*' at 0x9b63e64>,
+   <Whitespace ' ' at 0x9b63c5c>,
+   <Keyword 'from' at 0x9b63c84>,
+   <Whitespace ' ' at 0x9b63cd4>,
+   <Identifier '"somes...' at 0x9b5c62c>,
+   <Whitespace ' ' at 0x9b63f04>,
+   <Where 'where ...' at 0x9b5caac>)
+  >>>
+
+
+.. todo:: Describe general concepts
+   Why non-validating? Processing stages (tokens, groups,...), filter,
+
+
+Development & Contributing
+--------------------------
+
+Please file bug reports and feature requests on the project site at
+http://code.google.com/p/python-sqlparse/issues/entry or if you have
+code to contribute upload it to http://codereview.appspot.com and
+add albrecht.andi@googlemail.com as reviewer.
+
+For more information about the review tool and how to use it visit
+it's project page: http://code.google.com/p/rietveld.