Commits

Doug Hellmann committed c85922d

add sqltable extension

  • Participants
  • Parent commits c9fe47f

Comments (0)

Files changed (19)

 ,*~
 .DS_Store
 spelling/spelling_wordlist.txt
+sqltable/docs/sampledata.db
 
 syntax: glob
 */distribute-*.tar.gz
 clearquest:
    Robin Jarry <robin.jarry@gmail.com>
 
+sqltable:
+   Doug Hellmann <doug.hellmann@gmail.com>
+Copyright (c) 2012 by Doug Hellmann.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

sqltable/MANIFEST.in

+include README
+include LICENSE
+include CHANGES.*
+include test/test_wordlist.txt

sqltable/Makefile

+# Default target is to show help
+help:
+	@echo "sdist          - Source distribution"
+	@echo "html           - HTML documentation"
+	@echo "spelling       - Check spelling of documentation"
+	@echo "upload         - upload a new release to PyPI"
+	@echo "installwebsite - deploy web version of docs"
+	@echo "develop        - install development version"
+	@echo "test           - run the test suite"
+
+
+.PHONY: sdist
+sdist: html
+	python setup.py sdist
+
+.PHONY: upload
+upload: html
+	python setup.py sdist upload
+
+# Documentation
+.PHONY: html
+html:
+	(cd docs && make html)
+
+installwebsite: html
+	(cd docs/_build/html && rsync --rsh=ssh --archive --delete --verbose . www.doughellmann.com:/var/www/doughellmann/DocumentRoot/docs/sphinxcontrib-sqltable/)
+
+# Register the new version on pypi
+.PHONY: register
+register:
+	python setup.py register
+
+# Testing
+.PHONY: test
+test:
+	tox
+
+develop:
+	python setup.py develop
+.. -*- mode: rst -*-
+
+========================
+ sphinxcontrib-sqltable
+========================
+
+This package contains sphinxcontrb.sqltable, an extension to Sphinx to
+allow authors to embed SQL statements in source documents and produce
+tabular output in rendered documents.
+
+Refer to the `main documentation page
+<http://www.doughellmann.com/docs/sphinxcontrib.sqltable/>`__ for
+installation and setup details.
+
+License
+=======
+
+Copyright Doug Hellmann, All Rights Reserved
+
+Permission to use, copy, modify, and distribute this software and its
+documentation for any purpose and without fee is hereby granted,
+provided that the above copyright notice appear in all copies and that
+both that copyright notice and this permission notice appear in
+supporting documentation, and that the name of Doug Hellmann not be used
+in advertising or publicity pertaining to distribution of the software
+without specific, written prior permission.
+
+DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
+EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
+USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

sqltable/announce.rst

+============================
+ sphinxcontrib.sqltable 1.0
+============================
+
+What is sphinxcontrib.sqltable?
+===============================
+
+`sphinxcontrib.sqltable`_ is a Sphinx_ extension that allows authors
+to embed SQL statements in source documents and produce tabular output
+in rendered documents.
+
+What's New in 1.0
+==================
+
+This is the first public release of sphinxcontrib.sqltable.
+
+Installing
+==========
+
+Refer to the `main documentation page`_ for installation and setup
+details.
+
+.. _Sphinx: http://sphinx.pocoo.org/
+
+.. _main documentation page: http://www.doughellmann.com/docs/sphinxcontrib.sqltable/

sqltable/docs/Makefile

+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html: sampledatabase
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: sampledatabase
+sampledatabase:
+	rm -f sampledata.db
+	sqlite3 sampledata.db < sampledata.sql
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/sphinxcontrib-sqltable.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sphinxcontrib-sqltable.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/sphinxcontrib-sqltable"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sphinxcontrib-sqltable"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

sqltable/docs/conf.py

+# -*- coding: utf-8 -*-
+#
+# sphinxcontrib-sqltable documentation build configuration file, created by
+# sphinx-quickstart on Fri Jan  6 08:43:55 2012.
+#
+# 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.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+#sqltable_connection_string = 'sqlite:///sampledata.db'
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [ 'sphinxcontrib.sqltable',
+               'sphinx.ext.doctest',
+               ]
+
+# 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-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'sphinxcontrib-sqltable'
+copyright = u'2012, Doug Hellmann'
+
+# 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 = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# 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 patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# 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.  See the documentation for
+# a list of builtin themes.
+html_theme = 'nature'
+
+# 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 = []
+
+# 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_domain_indices = 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, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = 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 = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'sphinxcontrib-sqltabledoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'sphinxcontrib-sqltable.tex', u'sphinxcontrib-sqltable Documentation',
+   u'Doug Hellmann', '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
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'sphinxcontrib-sqltable', u'sphinxcontrib-sqltable Documentation',
+     [u'Doug Hellmann'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'sphinxcontrib-sqltable', u'sphinxcontrib-sqltable Documentation',
+   u'Doug Hellmann', 'sphinxcontrib-sqltable', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'

sqltable/docs/customize.rst

+.. _config-options:
+
+=======================
+ Configuration Options
+=======================
+
+Global Options
+==============
+
+These options can be set in ``conf.py`` along with the other Sphinx
+configuration settings.
+
+``sqltable_connection_string``
+  String specifying the default database to be used for queries,
+  in the format expected by SQLAlchemy_.
+
+Directive Options
+=================
+
+These options can be set each time the ``sqltable`` directive is used.
+
+``widths``
+  A comma- or space-separated list of relative column widths. The
+  default is equal-width columns (100%/#columns).
+``class``
+  Set a "classes" attribute value on the doctree element generated by
+  the directive. Useful for controlling style with CSS.
+``name``
+  Add text to the "names" attribute of the doctree element generated
+  by the directive. This allows hyperlink references to the element
+  using text as reference name.
+``connection_string``
+  String specifying the database to be used for queries, in the format
+  expected by SQLAlchemy_. Overrides any value of
+  ``sqltable_connection_string`` set in the ``conf.py``.
+
+
+.. _SQLAlchemy: http://www.sqlalchemy.org/

sqltable/docs/developers.rst

+============
+ Developers
+============
+
+If you would like to contribute to sphinxcontrib.sqltable directly,
+these instructions should help you get started.  Patches, bug reports,
+and feature requests are all welcome through the `BitBucket site
+<https://bitbucket.org/birkenfeld/sphinx-contrib/>`__.
+Contributions in the form of patches or pull requests are easier to
+integrate and will receive priority attention.
+
+Building Documentation
+======================
+
+The documentation for sphinxcontrib.sqltable is written in
+reStructuredText and converted to HTML using Sphinx. The build itself
+is driven by make.  You will need the following packages in order to
+build the docs:
+
+- Sphinx
+- docutils
+- sphinxcontrib.sqltable
+
+Once all of the tools are installed into a virtualenv using
+pip, run ``make html`` to generate the HTML version of the
+documentation.

sqltable/docs/example.rst

+==========
+ Examples
+==========
+
+Given a SQLite database containing:
+
+.. literalinclude:: sampledata.sql
+
+this reStructuredText input:
+
+::
+
+  .. sqltable:: List of Users
+     :connection_string: sqlite:///sampledata.db
+
+     select name as 'Name', email as 'E-mail' from users
+     order by Name asc
+
+produces this table:
+
+.. sqltable:: List of Users
+   :connection_string: sqlite:///sampledata.db
+
+   select name as 'Name', email as 'E-mail' from users
+   order by Name asc

sqltable/docs/history.rst

+=================
+ Release History
+=================
+
+1.0
+
+  - First public release.

sqltable/docs/index.rst

+.. sphinxcontrib-sqltable documentation master file, created by
+   sphinx-quickstart on Fri Jan  6 08:43:55 2012.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+========================
+ sphinxcontrib-sqltable
+========================
+
+``sphinxcontrb-sqltable`` is an extension to Sphinx_ to allow authors
+to embed SQL statements in source documents and produce tabular output
+in rendered documents.
+
+Features
+========
+
+1. Supports all databases accessible via SQLAlchemy.
+2. Supports global and query-specific database connection strings.
+
+Details
+=======
+
+.. toctree::
+   :maxdepth: 2
+
+   example
+   install
+   customize
+   developers
+   history
+
+.. _Sphinx: http://sphinx.pocoo.org/

sqltable/docs/install.rst

+==============
+ Installation
+==============
+
+Installing sphinxcontrib-sqltable
+=================================
+
+1. Install the extension with pip: ``pip install sphinxcontrib-sqltable``
+
+Configuration
+=============
+
+1. Add ``'sphinxcontrib.sqltable'`` to the ``extensions`` list in ``conf.py``.
+
+  ::
+
+    extensions = [ 'sphinxcontrib.sqltable' ]
+
+2. Set ``sqltable_connection_string`` in ``conf.py`` to point to the
+   database to be used for the queries.  See also :ref:`config-options`.
+
+.. _install-options:

sqltable/docs/sampledata.sql

+CREATE TABLE users (
+       name  text,
+       email text
+       );
+
+INSERT INTO users (name, email) VALUES ('John', 'john@example.com');
+INSERT INTO users (name, email) VALUES ('Jane', 'jane@example.com');
+INSERT INTO users (name, email) VALUES ('Bobby', 'bobby@example.com');
+INSERT INTO users (name, email) VALUES ('Suzy', 'suzy@example.com');

sqltable/setup.py

+# -*- coding: utf-8 -*-
+
+from setuptools import setup, find_packages
+
+f = open('README', 'r')
+try:
+    long_desc = f.read()
+finally:
+    f.close()
+
+requires = ['Sphinx>=0.6',
+            'SQLAlchemy',
+            ]
+
+setup(
+    name='sphinxcontrib-sqltable',
+    version='1.0',
+    url='http://bitbucket.org/birkenfeld/sphinx-contrib',
+    license='BSD',
+    author='Doug Hellmann',
+    author_email='doug.hellmann@gmail.com',
+    description='Sphinx "SQLTable" extension',
+    long_description=long_desc,
+    zip_safe=False,
+    classifiers=[
+        'Development Status :: 5 - Production/Stable',
+        'Environment :: Console',
+        'Environment :: Web Environment',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Topic :: Database',
+        'Topic :: Documentation',
+        'Topic :: Utilities',
+    ],
+    platforms='any',
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=requires,
+    namespace_packages=['sphinxcontrib'],
+)

sqltable/sphinxcontrib/__init__.py

+# -*- coding: utf-8 -*-
+"""
+    sphinxcontrib
+    ~~~~~~~~~~~~~
+
+    This package is a namespace package that contains all extensions
+    distributed in the ``sphinx-contrib`` distribution.
+
+    :copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+"""
+
+__import__('pkg_resources').declare_namespace(__name__)
+

sqltable/sphinxcontrib/sqltable.py

+#!/usr/bin/env python
+"""SQLTable extension for Sphinx.
+"""
+
+from docutils import nodes
+from docutils.parsers.rst.directives.tables import Table
+from docutils.parsers.rst import directives
+
+import sqlalchemy
+
+class SQLTable(Table):
+
+    option_spec = {'widths': directives.positive_int_list,
+                   'class': directives.class_option,
+                   'name': directives.unchanged,
+                   'connection_string':directives.unchanged,
+                   }
+
+    def run(self):
+        env = self.state.document.settings.env
+        app = env.app
+        config = app.config
+
+        # Make sure we have some content, which for now we assume is a
+        # query.
+        if not self.content:
+            error = self.state_machine.reporter.error(
+                'No query in sqltable directive',
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno)
+            return [error]
+
+        # Make sure the user told us about a database.
+        connection_string = self.options.get('connection_string',
+                                             config.sqltable_connection_string,
+                                             )
+        if not connection_string:
+            error = self.state_machine.reporter.error(
+                'No connection_string or sqltable_connection_string was specified for sqltable',
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno)
+            return [error]
+
+        # Make sure we can get the specified database.
+        try:
+            app.info('Connecting to %s' % connection_string)
+            engine = sqlalchemy.create_engine(connection_string)
+        except Exception, err:
+            error = self.state_machine.reporter.error(
+                'Could not connect to %s for sqltable' % (
+                    connection_string,
+                    ),
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno)
+            return [error]
+
+        # Run the query
+        try:
+            query = '\n'.join(self.content)
+            app.info('Running query %r' % query)
+            results = engine.execute(query)
+        except Exception, err:
+            error = self.state_machine.reporter.error(
+                u'Error with query %s for sqltable: %s' % (
+                    query,
+                    err,
+                    ),
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno)
+            return [error]
+
+        # Extract some values we need for building the table.
+        table_headers = results.keys()
+        table_body = results
+        max_cols = len(table_headers)
+        max_header_cols = max_cols
+
+        # Handle the width settings and title
+        try:
+            col_widths = self.get_column_widths(max_cols)
+            title, messages = self.make_title()
+        except SystemMessagePropagation, detail:
+            return [detail.args[0]]
+        except Exception, err:
+            error = self.state_machine.reporter.error(
+                'Error processing sqltable directive:\n%s' % err,
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno,
+                )
+            return [error]
+
+        # Build the node containing the table content
+        table_node = self.build_table(table_body, col_widths, table_headers)
+        table_node['classes'] += self.options.get('class', [])
+        self.add_name(table_node)
+        if title:
+            table_node.insert(0, title)
+        return [table_node] + messages
+
+    def build_table(self, table_data, col_widths, headers):
+        table = nodes.table()
+
+        # Set up the column specifications
+        # based on the widths.
+        tgroup = nodes.tgroup(cols=len(col_widths))
+        table += tgroup
+        tgroup.extend(nodes.colspec(colwidth=col_width)
+                      for col_width in col_widths)
+
+        # Add headers, if given.
+        if headers:
+            thead = nodes.thead()
+            tgroup += thead
+            row_node = nodes.row()
+            thead += row_node
+            row_node.extend(
+                nodes.entry(h, nodes.paragraph(text=h))
+                for h in headers
+                )
+
+        # The body of the table is made up of rows.
+        # Each row contains a series of entries,
+        # and each entry contains a paragraph of text.
+        tgroup += nodes.tbody(
+            '',
+            *[ nodes.row(
+                    '',
+                    *[nodes.entry(
+                            cell,
+                            nodes.paragraph(text=cell)
+                            )
+                      for cell in row]
+                    )
+               for row in table_data
+               ]
+            )
+
+        #print table
+        return table
+
+def setup(app):
+    app.info('Initializing SQLTable')
+    app.add_config_value('sqltable_connection_string', '', 'env')
+    app.add_directive('sqltable', SQLTable)