[Python-modules-commits] [python-agate-sql] 01/03: New upstream version 0.5.1
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Wed Mar 22 11:17:10 UTC 2017
This is an automated email from the git hooks/post-receive script.
ghisvail-guest pushed a commit to branch master
in repository python-agate-sql.
commit ee20f09a52695b9530d896f539bd085c2f03a304
Author: Ghislain Antony Vaillant <ghisvail at gmail.com>
Date: Wed Mar 15 12:29:59 2017 +0000
New upstream version 0.5.1
---
.gitignore | 12 +++
.travis.yml | 13 +++
AUTHORS.rst | 8 ++
CHANGELOG.rst | 39 +++++++
COPYING | 21 ++++
MANIFEST.in | 3 +
README.rst | 28 +++++
agatesql/__init__.py | 3 +
agatesql/table.py | 277 +++++++++++++++++++++++++++++++++++++++++++++++++
docs/Makefile | 130 +++++++++++++++++++++++
docs/conf.py | 225 +++++++++++++++++++++++++++++++++++++++
docs/index.rst | 82 +++++++++++++++
example.db | Bin 0 -> 2048 bytes
example.py | 13 +++
requirements-py2.txt | 9 ++
requirements-py3.txt | 7 ++
setup.cfg | 2 +
setup.py | 42 ++++++++
tests/__init__.py | 0
tests/test_agatesql.py | 123 ++++++++++++++++++++++
tox.ini | 32 ++++++
21 files changed, 1069 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..62c9247
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,12 @@
+.DS_Store
+*.pyc
+*.swp
+*.swo
+.tox
+*.egg-info
+docs/_build
+dist
+.coverage
+build
+.proof
+.test.png
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..21e6bd2
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,13 @@
+language: python
+python:
+ - "2.7"
+ - "3.3"
+ - "3.4"
+ - "3.5"
+ - "3.6"
+# command to install dependencies
+install:
+ - if [[ $TRAVIS_PYTHON_VERSION == 3* ]]; then pip install -r requirements-py3.txt; else pip install -r requirements-py2.txt; fi
+# command to run tests
+script: nosetests tests
+sudo: false
diff --git a/AUTHORS.rst b/AUTHORS.rst
new file mode 100644
index 0000000..9bcb640
--- /dev/null
+++ b/AUTHORS.rst
@@ -0,0 +1,8 @@
+The following individuals have contributed code to agate-sql:
+
+* `Christopher Groskopf <https://github.com/onyxfish>`_
+* `Adrian Klaver <https://github.com/aklaver>`_
+* `James McKinney <https://github.com/jpmckinney>`_
+* `Chris Keller <https://github.com/chrislkeller>`_
+* `git-clueless <https://github.com/git-clueless>`_
+* `z2s8 <https://github.com/z2s8>`_
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
new file mode 100644
index 0000000..c0a58e5
--- /dev/null
+++ b/CHANGELOG.rst
@@ -0,0 +1,39 @@
+0.5.1 - February 27, 2017
+--------------------------
+
+* Add ``prefixes`` option to :func:`.to_sql` to add expressions following the INSERT keyword, like OR IGNORE or OR REPLACE.
+* Use ``TIMESTAMP`` instead of ``DATETIME`` for DateTime columns.
+
+0.5.0 - December 23, 2016
+-------------------------
+
+* ``VARCHAR`` columns are now generated with proper length constraints (unless explicilty disabled).
+* Tables can now be created from query results using :func:`.from_sql_query`.
+* Add support for running queries directly on tables with :func:`.sql_query`.
+* When creating tables, ``NOT NULL`` constraints will be created by default.
+* SQL create statements can now be generated without being executed with :func:`.to_sql_create_statement`
+
+0.4.0 - December 19, 2016
+-------------------------
+
+* Modified ``example.py`` so it no longer depends on Postgres.
+* It is no longer necessary to run :code:`agatesql.patch()` after importing agatesql.
+* Upgrade required agate to ``1.5.0``.
+
+0.3.0 - November 5, 2015
+------------------------
+
+* Add ``overwrite`` flag to :meth:`.TableSQL.to_sql`.
+* Removed Python 2.6 support.
+* Updated agate dependency to version 1.1.0.
+* Additional SQL types are now supported. (#4, #10)
+
+0.2.0 - October 22, 2015
+------------------------
+
+* Add explicit patch function.
+
+0.1.0 - September 22, 2015
+--------------------------
+
+* Initial version.
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..8f55739
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 Christopher Groskopf and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..45eee36
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,3 @@
+include COPYING
+include AUTHORS.rst
+include README.rst
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..f5d1450
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,28 @@
+.. image:: https://travis-ci.org/wireservice/agate-sql.png
+ :target: https://travis-ci.org/wireservice/agate-sql
+ :alt: Build status
+
+.. image:: https://img.shields.io/pypi/dw/agate-sql.svg
+ :target: https://pypi.python.org/pypi/agate-sql
+ :alt: PyPI downloads
+
+.. image:: https://img.shields.io/pypi/v/agate-sql.svg
+ :target: https://pypi.python.org/pypi/agate-sql
+ :alt: Version
+
+.. image:: https://img.shields.io/pypi/l/agate-sql.svg
+ :target: https://pypi.python.org/pypi/agate-sql
+ :alt: License
+
+.. image:: https://img.shields.io/pypi/pyversions/agate-sql.svg
+ :target: https://pypi.python.org/pypi/agate-sql
+ :alt: Support Python versions
+
+agate-sql adds SQL read/write support to `agate <https://github.com/wireservice/agate>`_.
+
+Important links:
+
+* agate http://agate.rtfd.org
+* Documentation: http://agate-sql.rtfd.org
+* Repository: https://github.com/wireservice/agate-sql
+* Issues: https://github.com/wireservice/agate-sql/issues
diff --git a/agatesql/__init__.py b/agatesql/__init__.py
new file mode 100644
index 0000000..2ca862d
--- /dev/null
+++ b/agatesql/__init__.py
@@ -0,0 +1,3 @@
+#!/usr/bin/env python
+
+import agatesql.table
diff --git a/agatesql/table.py b/agatesql/table.py
new file mode 100644
index 0000000..93a468a
--- /dev/null
+++ b/agatesql/table.py
@@ -0,0 +1,277 @@
+#!/usr/bin/env python
+
+"""
+This module contains the agatesql extensions to
+:class:`Table <agate.table.Table>`.
+"""
+
+import decimal
+import datetime
+import six
+import agate
+from sqlalchemy import Column, MetaData, Table, create_engine, dialects
+from sqlalchemy.engine import Connection
+from sqlalchemy.types import BOOLEAN, DECIMAL, DATE, TIMESTAMP, VARCHAR, Interval
+from sqlalchemy.dialects.oracle import INTERVAL as ORACLE_INTERVAL
+from sqlalchemy.dialects.postgresql import INTERVAL as POSTGRES_INTERVAL
+from sqlalchemy.schema import CreateTable
+from sqlalchemy.sql import select
+
+SQL_TYPE_MAP = {
+ agate.Boolean: BOOLEAN,
+ agate.Number: DECIMAL,
+ agate.Date: DATE,
+ agate.DateTime: TIMESTAMP,
+ agate.TimeDelta: None, # See below
+ agate.Text: VARCHAR
+}
+
+INTERVAL_MAP = {
+ 'postgresql': POSTGRES_INTERVAL,
+ 'oracle': ORACLE_INTERVAL
+}
+
+def get_connection(connection_or_string=None):
+ """
+ Gets a connection to a specific SQL alchemy backend. If an existing
+ connection is provided, it will be passed through. If no connection
+ string is provided, then in in-memory SQLite database will be created.
+ """
+ if connection_or_string is None:
+ engine = create_engine('sqlite:///:memory:')
+ connection = engine.connect()
+ elif isinstance(connection_or_string, Connection):
+ connection = connection_or_string
+ else:
+ engine = create_engine(connection_or_string)
+ connection = engine.connect()
+
+ return connection
+
+def from_sql(cls, connection_or_string, table_name):
+ """
+ Create a new :class:`agate.Table` from a given SQL table. Types will be
+ inferred from the database schema.
+
+ Monkey patched as class method :meth:`Table.from_sql`.
+
+ :param connection_or_string:
+ An existing sqlalchemy connection or connection string.
+ :param table_name:
+ The name of a table in the referenced database.
+ """
+ connection = get_connection(connection_or_string)
+
+ metadata = MetaData(connection)
+ sql_table = Table(table_name, metadata, autoload=True, autoload_with=connection)
+
+ column_names = []
+ column_types = []
+
+ for sql_column in sql_table.columns:
+ column_names.append(sql_column.name)
+
+ if type(sql_column.type) in INTERVAL_MAP.values():
+ py_type = datetime.timedelta
+ else:
+ py_type = sql_column.type.python_type
+
+ if py_type in [int, float, decimal.Decimal]:
+ if py_type is float:
+ sql_column.type.asdecimal = True
+ column_types.append(agate.Number())
+ elif py_type is bool:
+ column_types.append(agate.Boolean())
+ elif issubclass(py_type, six.string_types):
+ column_types.append(agate.Text())
+ elif py_type is datetime.date:
+ column_types.append(agate.Date())
+ elif py_type is datetime.datetime:
+ column_types.append(agate.DateTime())
+ elif py_type is datetime.timedelta:
+ column_types.append(agate.TimeDelta())
+ else:
+ raise ValueError('Unsupported sqlalchemy column type: %s' % type(sql_column.type))
+
+ s = select([sql_table])
+
+ rows = connection.execute(s)
+
+ return agate.Table(rows, column_names, column_types)
+
+def from_sql_query(self, query):
+ """
+ Create an agate table from the results of a SQL query. Note that column
+ data types will be inferred from the returned data, not the column types
+ declared in SQL (if any). This is more flexible than :func:`.from_sql` but
+ could result in unexpected typing issues.
+
+ :param query:
+ A SQL query to execute.
+ """
+ connection = get_connection()
+
+ # Must escape '%'.
+ # @see https://github.com/wireservice/csvkit/issues/440
+ # @see https://bitbucket.org/zzzeek/sqlalchemy/commits/5bc1f17cb53248e7cea609693a3b2a9bb702545b
+ rows = connection.execute(query.replace('%', '%%'))
+
+ table = agate.Table(list(rows), column_names=rows._metadata.keys)
+
+ return table
+
+def make_sql_column(column_name, column, sql_type_kwargs=None, sql_column_kwargs=None):
+ """
+ Creates a sqlalchemy column from agate column data.
+
+ :param column_name:
+ The name of the column.
+ :param column:
+ The agate column.
+ :param sql_column_kwargs:
+ Additional kwargs to passed through to the Column constructor, such as
+ ``nullable``.
+ """
+ sql_column_type = None
+
+ for agate_type, sql_type in SQL_TYPE_MAP.items():
+ if isinstance(column.data_type, agate_type):
+ sql_column_type = sql_type
+ break
+
+ if sql_column_type is None:
+ raise ValueError('Unsupported column type: %s' % column_type)
+
+ sql_type_kwargs = sql_type_kwargs or {}
+ sql_column_kwargs = sql_column_kwargs or {}
+
+ return Column(column_name, sql_column_type(**sql_type_kwargs), **sql_column_kwargs)
+
+def make_sql_table(table, table_name, dialect=None, db_schema=None, constraints=True, connection=None):
+ """
+ Generates a SQL alchemy table from an agate table.
+ """
+ metadata = MetaData(connection)
+ sql_table = Table(table_name, metadata, schema=db_schema)
+
+ if dialect in INTERVAL_MAP.keys():
+ SQL_TYPE_MAP[agate.TimeDelta] = INTERVAL_MAP[dialect]
+ else:
+ SQL_TYPE_MAP[agate.TimeDelta] = Interval
+
+ for column_name, column in table.columns.items():
+ sql_type_kwargs = {}
+ sql_column_kwargs = {}
+
+ if constraints:
+ if isinstance(column.data_type, agate.Text):
+ sql_type_kwargs['length'] = table.aggregate(agate.MaxLength(column_name))
+
+ # Avoid errors due to NO_ZERO_DATE.
+ # @see http://dev.mysql.com/doc/refman/5.7/en/sql-mode.html#sqlmode_no_zero_date
+ if not isinstance(column.data_type, agate.DateTime):
+ sql_column_kwargs['nullable'] = table.aggregate(agate.HasNulls(column_name))
+
+ sql_table.append_column(make_sql_column(column_name, column, sql_type_kwargs, sql_column_kwargs))
+
+ return sql_table
+
+def to_sql(self, connection_or_string, table_name, overwrite=False, create=True, insert=True, prefixes=[], db_schema=None, constraints=True):
+ """
+ Write this table to the given SQL database.
+
+ Monkey patched as instance method :meth:`Table.to_sql`.
+
+ :param connection_or_string:
+ An existing sqlalchemy connection or a connection string.
+ :param table_name:
+ The name of the SQL table to create.
+ :param overwrite:
+ Drop any existing table with the same name before creating.
+ :param create:
+ Create the table.
+ :param insert:
+ Insert table data.
+ :param prefixes:
+ Add prefixes to the insert query.
+ :param db_schema:
+ Create table in the specified database schema.
+ :param constraints
+ Generate constraints such as ``nullable`` for table columns.
+ """
+ connection = get_connection(connection_or_string)
+
+ dialect = connection.engine.dialect.name
+ sql_table = make_sql_table(self, table_name, dialect=dialect, db_schema=db_schema, constraints=constraints, connection=connection)
+
+ if create:
+ if overwrite:
+ sql_table.drop(checkfirst=True)
+
+ sql_table.create()
+
+ if insert:
+ insert = sql_table.insert()
+ for prefix in prefixes:
+ insert = insert.prefix_with(prefix)
+ connection.execute(insert, [dict(zip(self.column_names, row)) for row in self.rows])
+
+ return sql_table
+
+def to_sql_create_statement(self, table_name, dialect=None, db_schema=None, constraints=True):
+ """
+ Generates a CREATE TABLE statement for this SQL table, but does not execute
+ it.
+
+ :param table_name:
+ The name of the SQL table to create.
+ :param dialect:
+ The dialect of SQL to use for the table statement.
+ :param db_schema:
+ Create table in the specified database schema.
+ :param constraints
+ Generate constraints such as ``nullable`` for table columns.
+ """
+ sql_table = make_sql_table(self, table_name, dialect=dialect, db_schema=db_schema, constraints=constraints)
+
+ if dialect:
+ sql_dialect = dialects.registry.load(dialect)()
+ else:
+ sql_dialect = None
+
+ return six.text_type(CreateTable(sql_table).compile(dialect=sql_dialect)).strip() + ';'
+
+def sql_query(self, query, table_name='agate'):
+ """
+ Convert this agate table into an intermediate, in-memory sqlite table,
+ run a query against it, and then return the results as a new agate table.
+
+ Multiple queries may be separated with semicolons.
+
+ :param query:
+ One SQL query, or multiple queries to be run consecutively separated
+ with semicolons.
+ :param table_name:
+ The name to use for the table in the queries, defaults to ``agate``.
+ """
+ connection = get_connection()
+
+ # Execute the specified SQL queries
+ queries = query.split(';')
+ rows = None
+
+ sql_table = self.to_sql(connection, table_name)
+
+ for q in queries:
+ if q:
+ rows = connection.execute(q)
+
+ table = agate.Table(list(rows), column_names=rows._metadata.keys)
+
+ return table
+
+agate.Table.from_sql = classmethod(from_sql)
+agate.Table.from_sql_query = classmethod(from_sql_query)
+agate.Table.to_sql = to_sql
+agate.Table.to_sql_create_statement = to_sql_create_statement
+agate.Table.sql_query = sql_query
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..839f016
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,130 @@
+# 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) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+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 " 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:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+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/agatesql.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/agatesql.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/agatesql"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/agatesql"
+ @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."
+
+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."
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..c328d64
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,225 @@
+# -*- coding: utf-8 -*-
+#
+# 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 os
+import sys
+
+# 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 -----------------------------------------------------
+
+# 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 = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
+autodoc_member_order = 'bysource'
+
+intersphinx_mapping = {
+ 'python': ('http://docs.python.org/3.5/', None),
+ 'agate': ('http://agate.readthedocs.org/en/latest/', None)
+}
+
+# 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'agate-sql'
+copyright = u'2015, Christopher Groskopf'
+
+# 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.5.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.5.1 (alpha)'
+
+# 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 = 'default'
+
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd: # only import and set the theme if we're building docs locally
+ import sphinx_rtd_theme
+ html_theme = 'sphinx_rtd_theme'
+ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# 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 = 'agatesqldoc'
+
+
+# -- 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', 'agate-sql.tex', u'agate-sql Documentation',
+ u'Christopher Groskopf', '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
+
+# 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_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 = [
+]
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..2916bfa
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,82 @@
+===================
+agate-sql |release|
+===================
+
+.. include:: ../README.rst
+
+Install
+=======
+
+To install:
+
+.. code-block:: bash
+
+ pip install agate-sql
+
+For details on development or supported platforms see the `agate documentation <http://agate.readthedocs.org>`_.
+
+.. warning::
+
+ You'll need to have the correct `sqlalchemy drivers <http://docs.sqlalchemy.org/en/rel_1_0/dialects/index.html>`_ installed for whatever database you plan to access. For instance, in order to read/write tables in a Postgres database, you'll also need to ``pip install psycopg2``.
+
+Usage
+=====
+
+agate-sql uses a monkey patching pattern to add SQL support to all :class:`agate.Table <agate.table.Table>` instances.
+
+.. code-block:: python
+
+ import agate
+ import agatesql
+
+Importing :mod:`.agatesql` attaches new methods to :class:`agate.Table <agate.table.Table>`. For example, to import a table named :code:`doctors` from a local postgresql database named :code:`hospitals` you will use :meth:`.from_sql`:
+
+.. code-block:: python
+
+ new_table = agate.Table.from_sql('postgresql:///hospitals', 'doctors')
+
+To save this table back to the database:
+
+.. code-block:: python
+
+ new_table.to_sql('postgresql:///hospitals', 'doctors')
+
+The first argument to either function can be any valid `sqlalchemy connection string <http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html>`_. The second argument must be a database name. (Arbitrary SQL queries are not supported.)
+
+That's all there is to it.
+
+===
+API
+===
+
+.. autofunction:: agatesql.table.from_sql
+
+.. autofunction:: agatesql.table.from_sql_query
+
+.. autofunction:: agatesql.table.to_sql
+
+.. autofunction:: agatesql.table.to_sql_create_statement
+
+.. autofunction:: agatesql.table.sql_query
+
+Authors
+=======
+
+.. include:: ../AUTHORS.rst
+
+Changelog
+=========
+
+.. include:: ../CHANGELOG.rst
+
+License
+=======
+
+.. include:: ../COPYING
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/example.db b/example.db
new file mode 100644
index 0000000..163f76e
Binary files /dev/null and b/example.db differ
diff --git a/example.py b/example.py
new file mode 100755
index 0000000..98c4e0a
--- /dev/null
+++ b/example.py
@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+
+import agate
+import agatesql
+
+table = agate.Table.from_sql('sqlite:///example.db', 'test')
+
+print(table.column_names)
+print(table.column_types)
+print(len(table.columns))
+print(len(table.rows))
+
+table.to_sql('sqlite:///example.db', 'test', overwrite=True)
diff --git a/requirements-py2.txt b/requirements-py2.txt
new file mode 100644
index 0000000..af13404
--- /dev/null
+++ b/requirements-py2.txt
@@ -0,0 +1,9 @@
+unittest2==0.5.1
+nose>=1.1.2
+tox>=1.3
+Sphinx>=1.2.2
+sphinx_rtd_theme>=0.1.6
+wheel>=0.24.0
+agate>=1.5.0
+sqlalchemy>=1.0.8
+ordereddict>=1.1
diff --git a/requirements-py3.txt b/requirements-py3.txt
new file mode 100644
index 0000000..16d796c
--- /dev/null
+++ b/requirements-py3.txt
@@ -0,0 +1,7 @@
+nose>=1.1.2
+tox>=1.3
+Sphinx>=1.2.2
+sphinx_rtd_theme>=0.1.6
+wheel>=0.24.0
+agate>=1.5.0
+sqlalchemy>=1.0.8
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..2a9acf1
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,2 @@
+[bdist_wheel]
... 219 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-agate-sql.git
More information about the Python-modules-commits
mailing list