Commits

Jean-Tiare Le Bigot committed c1144e7

WIP documentation and status

  • Participants
  • Parent commits 71a1e42

Comments (0)

Files changed (14)

 *.pyc
 *.egg*
 .coverage
-ddbmock/.noseids
-ddbmock/coverage.xml
+
+build
+_build
+dist
+
+coverage.xml
 nosetests.xml
+.coverage
+.noseids
     def connect_ddbmock(host='localhost', port=6543):
         import boto
         from boto.regioninfo import RegionInfo
-        endpoint = '{}:{}'.format(host:port)
+        endpoint = '{}:{}'.format(host, port)
         region = RegionInfo(name='ddbmock', endpoint=endpoint)
         return boto.connect_dynamodb(region=region, port=port, is_secure=False)
 

File ddbmock/tests/functional/boto/test_batch_get_item.py

+# -*- coding: utf-8 -*-
+
+import unittest
+import boto
+
+TABLE_NAME1 = 'Table-HR'
+TABLE_NAME2 = 'Table-H'
+TABLE_NAME_404 = 'Waldo'
+TABLE_RT = 45
+TABLE_WT = 123
+TABLE_RT2 = 10
+TABLE_WT2 = 10
+TABLE_HK_NAME = u'hash_key'
+TABLE_HK_TYPE = u'N'
+TABLE_RK_NAME = u'range_key'
+TABLE_RK_TYPE = u'S'
+
+HK_VALUE1 = u'123'
+HK_VALUE2 = u'456'
+HK_VALUE3 = u'789'
+RK_VALUE1 = u'Waldo-1'
+RK_VALUE2 = u'Waldo-2'
+RK_VALUE3 = u'Waldo-3'
+RK_VALUE4 = u'Waldo-4'
+RK_VALUE5 = u'Waldo-5'
+
+
+ITEM1 = {
+    TABLE_HK_NAME: {TABLE_HK_TYPE: HK_VALUE1},
+    TABLE_RK_NAME: {TABLE_RK_TYPE: RK_VALUE1},
+    u'relevant_data': {u'S': u'tata'},
+}
+ITEM2 = {
+    TABLE_HK_NAME: {TABLE_HK_TYPE: HK_VALUE1},
+    TABLE_RK_NAME: {TABLE_RK_TYPE: RK_VALUE2},
+    u'relevant_data': {u'S': u'tete'},
+}
+ITEM3 = {
+    TABLE_HK_NAME: {TABLE_HK_TYPE: HK_VALUE2},
+    TABLE_RK_NAME: {TABLE_RK_TYPE: RK_VALUE3},
+    u'relevant_data': {u'S': u'titi'},
+}
+ITEM4 = {
+    TABLE_HK_NAME: {TABLE_HK_TYPE: HK_VALUE2},
+    TABLE_RK_NAME: {TABLE_RK_TYPE: RK_VALUE4},
+    u'relevant_data': {u'S': u'toto'},
+}
+ITEM5 = {
+    TABLE_HK_NAME: {TABLE_HK_TYPE: HK_VALUE3},
+    TABLE_RK_NAME: {TABLE_RK_TYPE: RK_VALUE5},
+    u'relevant_data': {u'S': u'tutu'},
+}
+
+# Please note that most query features are not yet implemented hence not tested
+class TestBatchGetItem(unittest.TestCase):
+    def setUp(self):
+        from ddbmock.database.db import DynamoDB
+        from ddbmock.database.table import Table
+        from ddbmock.database.key import PrimaryKey
+
+        db = DynamoDB()
+        db.hard_reset()
+
+        hash_key = PrimaryKey(TABLE_HK_NAME, TABLE_HK_TYPE)
+        range_key = PrimaryKey(TABLE_RK_NAME, TABLE_RK_TYPE)
+
+        self.t1 = Table(TABLE_NAME1, TABLE_RT, TABLE_WT, hash_key, range_key)
+        self.t2 = Table(TABLE_NAME2, TABLE_RT, TABLE_WT, hash_key, None)
+
+        db.data[TABLE_NAME1]  = self.t1
+        db.data[TABLE_NAME2]  = self.t2
+
+        self.t1.put(ITEM1, {})
+        self.t1.put(ITEM2, {})
+        self.t1.put(ITEM3, {})
+        self.t2.put(ITEM4, {})
+        self.t2.put(ITEM5, {})
+
+    def tearDown(self):
+        from ddbmock.database.db import DynamoDB
+        DynamoDB().hard_reset()
+
+    def test_batch_get_item_nominal(self):
+        from ddbmock import connect_boto
+        from ddbmock.database.db import DynamoDB
+
+        db = connect_boto()
+
+        expected = {
+            "Responses": {
+                "Table-HR": {
+                    "Items": [
+                        {"relevant_data": {"S": "tata"}, "hash_key": {"N": "123"}, "range_key": {"S": "Waldo-1"}},
+                        {"relevant_data": {"S": "tata"}, "hash_key": {"N": "123"}, "range_key": {"S": "Waldo-1"}},
+                    ],
+                    "ConsumedCapacityUnits": 1.0
+                },
+                "Table-H": {
+                    "Items": [
+                        {"relevant_data": {"S": "tutu"}, "hash_key": {"N": "789"}, "range_key": {"S": "Waldo-5"}},
+                    ],
+                    "ConsumedCapacityUnits": 0.5
+                }
+            }
+        }
+
+        ret = db.layer1.batch_get_item({
+            TABLE_NAME1: {
+                u"Keys": [
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE1}, u"RangeKeyElement": {TABLE_RK_TYPE: RK_VALUE1}},
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE1}, u"RangeKeyElement": {TABLE_RK_TYPE: RK_VALUE1}},
+                ],
+            },
+            TABLE_NAME2: {
+                u"Keys": [
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE3}},
+                    {u"HashKeyElement": {TABLE_HK_TYPE: u"404"}},
+                ],
+            },
+        })
+        self.assertEqual(expected, ret)
+
+    def test_batch_get_item_filter_one(self):
+        from ddbmock import connect_boto
+        from ddbmock.database.db import DynamoDB
+
+        db = connect_boto()
+
+        expected = {
+            "Responses": {
+                "Table-HR": {
+                    "Items": [
+                        {"relevant_data": {"S": "tata"}},
+                        {"relevant_data": {"S": "tata"}},
+                    ],
+                    "ConsumedCapacityUnits": 1.0
+                },
+                "Table-H": {
+                    "Items": [
+                        {"relevant_data": {"S": "tutu"}, "hash_key": {"N": "789"}, "range_key": {"S": "Waldo-5"}},
+                    ],
+                    "ConsumedCapacityUnits": 0.5
+                }
+            }
+        }
+
+        ret = db.layer1.batch_get_item({
+            TABLE_NAME1: {
+                u"Keys": [
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE1}, u"RangeKeyElement": {TABLE_RK_TYPE: RK_VALUE1}},
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE1}, u"RangeKeyElement": {TABLE_RK_TYPE: RK_VALUE1}},
+                ],
+                u"AttributesToGet": [u"relevant_data"],
+            },
+            TABLE_NAME2: {
+                u"Keys": [
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE3}},
+                ],
+            },
+        })
+        self.assertEqual(expected, ret)
+
+    def test_batch_get_item_table_404(self):
+        from ddbmock import connect_boto
+        from ddbmock.database.db import DynamoDB
+        from boto.exception import BotoServerError
+
+        db = connect_boto()
+
+        self.assertRaises(BotoServerError, db.layer1.batch_get_item, {
+            TABLE_NAME_404: {
+                u"Keys": [
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE1}, u"RangeKeyElement": {TABLE_RK_TYPE: RK_VALUE1}},
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE1}, u"RangeKeyElement": {TABLE_RK_TYPE: RK_VALUE1}},
+                ],
+            },
+            TABLE_NAME2: {
+                u"Keys": [
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE3}},
+                ],
+            },
+        })
+
+    def test_batch_get_item_bad_key(self):
+        from ddbmock import connect_boto
+        from ddbmock.database.db import DynamoDB
+        from boto.dynamodb.exceptions import DynamoDBValidationError
+
+        db = connect_boto()
+
+        self.assertRaises(DynamoDBValidationError, db.layer1.batch_get_item,
+        {
+            TABLE_NAME1: {
+                u"Keys": [
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE1}, u"RangeKeyElement": {TABLE_RK_TYPE: RK_VALUE1}},
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE1}},
+                ],
+            },
+            TABLE_NAME2: {
+                u"Keys": [
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE3}},
+                ],
+            },
+        })
+
+        self.assertRaises(DynamoDBValidationError, db.layer1.batch_get_item,
+        {
+            TABLE_NAME1: {
+                u"Keys": [
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE1}, u"RangeKeyElement": {TABLE_RK_TYPE: RK_VALUE1}},
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE1}, u"RangeKeyElement": {TABLE_RK_TYPE: RK_VALUE1}},
+                ],
+            },
+            TABLE_NAME2: {
+                u"Keys": [
+                    {u"HashKeyElement": {TABLE_HK_TYPE: HK_VALUE3}, u"RangeKeyElement": {TABLE_RK_TYPE: RK_VALUE1}},
+                ],
+            },
+        })

File ddbmock/validators/batch_get_item.py

+# -*- coding: utf-8 -*-
+
+from .types import table_name, optional, get_key_schema, attributes_to_get_schema
+
+post = {
+    u"RequestItems": {
+        table_name: {
+            u"Keys": [get_key_schema],
+            optional(u'AttributesToGet'): attributes_to_get_schema, #FIXME: handle default,
+        },
+    },
+}

File ddbmock/views/batch_get_item.py

+# -*- coding: utf-8 -*-
+
+from pyramid.view import view_config
+from ddbmock.database import DynamoDB
+from ddbmock.validators import dynamodb_api_validate
+from ddbmock.errors import wrap_exceptions
+
+# Real work
+@wrap_exceptions
+@dynamodb_api_validate
+def batch_get_item(post):
+    #TODO: limit to 100/batch
+    #TODO: unprocessed keys
+
+    return {
+        "Responses": DynamoDB().get_batch(post[u'RequestItems']),
+    }
+
+# Pyramid route wrapper
+@view_config(route_name='batch_get_item', renderer='json')
+def pyramid_batch_get_item(request):
+    return batch_get_item(request.json)

File 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:
+    $(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/dynamodb-mapper.qhcp"
+    @echo "To view the help file:"
+    @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/dynamodb-mapper.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/dynamodb-mapper"
+    @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/dynamodb-mapper"
+    @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."

File docs/_include/intro.rst

+`DynamoDB <http://aws.amazon.com/dynamodb/>`_ is a minimalistic NoSQL engine
+provided by Amazon as a part of their AWS product.
+
+**DynamoDB** is great in production environement but sucks when testing your
+application. Tables needs roughtly 1 min to be created, deleted or updated.
+Items operation rates depends on how much you pay and tests will conflict if
+2 developers run them at the same time.
+
+**ddbmock** brings a tiny in-memory(tm) implementation of DynamoDB API. It can
+either be run as a stand alone server or as a regular library helping you to
+build lightning fast unit and functional tests :)
+
+**ddbmock** does *not* intend to be production ready. It *will* **loose** you
+data. you've been warned! I currently recommend the "boto extension" mode for
+unit-tests and the "server" mode for functional tests.

File docs/conf.py

+# -*- coding: utf-8 -*-
+#
+# ddbmock documentation build configuration file, created by
+# sphinx-quickstart on Fri Aug  3 10:48:56 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 -----------------------------------------------------
+
+# 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.todo', 'sphinx.ext.coverage']
+
+# 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'DynamoDB-mock'
+copyright = u'2012, Ludia Inc.'
+
+# 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.3'
+# The full version, including alpha/beta/rc tags.
+release = '0.3.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 patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build', '_include']
+
+# 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'
+
+# 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 = 'ddbmock_doc'
+
+
+# -- 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', 'ddbmock.tex', u'DynamoDB-mock Documentation',
+   u'Jean-Tiare Le Bigot', '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', 'ddbmock', u'DynamoDB-mock Documentation',
+     [u'Jean-Tiare Le Bigot'], 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', 'ddbmock', u'DynamoDB-mock Documentation',
+   u'Jean-Tiare Le Bigot', 'ddbmock', 'In-memory DynamoDB implementation.',
+   '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'
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'DynamoDB-mock Documentation'
+epub_author = u'Jean-Tiare Le Bigot'
+epub_publisher = u'Jean-Tiare Le Bigot'
+epub_copyright = u'2012, Ludia Inc.'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True

File docs/index.rst

+############################
+DynamoDB-mock documentation.
+############################
+
+Overview
+========
+
+.. include:: _include/intro.rst
+
+Documentation
+=============
+
+User guide
+----------
+
+.. toctree::
+   :maxdepth: 3
+
+   pages/getting_started
+   pages/status
+
+   pages/changelog
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+Contribute
+==========
+
+Want to contribute, report a but of request a feature ? The development goes on
+BitBucket:
+
+- **Report bugs**: https://bitbucket.org/jtlebigot/dynamodb-mock/issues
+- **Fork the code**: https://bitbucket.org/jtlebigot/dynamodb-mock/overview

File docs/make.bat

+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+    set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+    set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+    set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+    :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.  text       to make text files
+    echo.  man        to make manual pages
+    echo.  texinfo    to make Texinfo files
+    echo.  gettext    to make PO message catalogs
+    echo.  changes    to make an overview over 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
+    goto end
+)
+
+if "%1" == "clean" (
+    for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+    del /q /s %BUILDDIR%\*
+    goto end
+)
+
+if "%1" == "html" (
+    %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+    goto end
+)
+
+if "%1" == "dirhtml" (
+    %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+    goto end
+)
+
+if "%1" == "singlehtml" (
+    %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+    goto end
+)
+
+if "%1" == "pickle" (
+    %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished; now you can process the pickle files.
+    goto end
+)
+
+if "%1" == "json" (
+    %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished; now you can process the JSON files.
+    goto end
+)
+
+if "%1" == "htmlhelp" (
+    %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+    goto end
+)
+
+if "%1" == "qthelp" (
+    %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+    echo.^> qcollectiongenerator %BUILDDIR%\qthelp\dynamodb-mapper.qhcp
+    echo.To view the help file:
+    echo.^> assistant -collectionFile %BUILDDIR%\qthelp\dynamodb-mapper.ghc
+    goto end
+)
+
+if "%1" == "devhelp" (
+    %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished.
+    goto end
+)
+
+if "%1" == "epub" (
+    %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished. The epub file is in %BUILDDIR%/epub.
+    goto end
+)
+
+if "%1" == "latex" (
+    %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+    goto end
+)
+
+if "%1" == "text" (
+    %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished. The text files are in %BUILDDIR%/text.
+    goto end
+)
+
+if "%1" == "man" (
+    %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished. The manual pages are in %BUILDDIR%/man.
+    goto end
+)
+
+if "%1" == "texinfo" (
+    %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+    goto end
+)
+
+if "%1" == "gettext" (
+    %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+    goto end
+)
+
+if "%1" == "changes" (
+    %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.The overview file is in %BUILDDIR%/changes.
+    goto end
+)
+
+if "%1" == "linkcheck" (
+    %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+    goto end
+)
+
+if "%1" == "doctest" (
+    %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+    if errorlevel 1 exit /b 1
+    echo.
+    echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+    goto end
+)
+
+:end

File docs/pages/changelog.rst

+#############################
+Change log - Migration guide.
+#############################
+
+.. include:: ../../CHANGES.rst

File docs/pages/getting_started.rst

+##################################
+Getting started with DynamoDB-mock
+##################################
+
+.. include:: ../_include/intro.rst
+
+Installation
+============
+
+::
+
+    $ pip install ddbmock
+
+
+Example usage
+=============
+
+Run as Regular client-server
+----------------------------
+
+Ideal for test environment. For stage and production I highly recommend using
+DynamoDB servers. ddbmock comes with no warranty and *will* **loose your data(tm)**.
+
+::
+
+    $ pserve development.ini # launch the server on 0.0.0.0:6543
+
+::
+
+    import boto
+    from ddbmock import connect_ddbmock
+
+    # Use the provided helper to connect your *own* endpoint
+    db = connect_ddbmock()
+
+    # Done ! just use it wherever in your project as usual.
+    db.list_tables() # get list of tables (empty at this stage)
+
+Note: if you do not want to import ddbmock only for the helper, here is a
+reference implementation:
+
+::
+
+    def connect_ddbmock(host='localhost', port=6543):
+        import boto
+        from boto.regioninfo import RegionInfo
+        endpoint = '{}:{}'.format(host, port)
+        region = RegionInfo(name='ddbmock', endpoint=endpoint)
+        return boto.connect_dynamodb(region=region, port=port, is_secure=False)
+
+Run as a standalone library
+---------------------------
+
+Ideal for unit testing or small scale automated functional tests. Nice to play
+around with boto DynamoDB API too :)
+
+::
+
+    import boto
+    from ddbmock import connect_boto
+
+    # Wire-up boto and ddbmock together
+    db = connect_boto()
+
+    # Done ! just use it wherever in your project as usual.
+    db.list_tables() # get list of tables (empty at this stage)

File docs/pages/status.rst

+##############
+Current Status
+##############
+
+Methods support
+===============
+
+- ``CreateTable`` DONE
+- ``DeleteTable`` DONE
+- ``UpdateTable`` DONE
+- ``DescribeTable`` DONE
+- ``GetItem DONE
+- ``PutItem`` DONE
+- ``DeleteItem`` DONE
+- ``UpdateItem`` ALMOST
+- ``BatchGetItem`` WIP
+- ``BatchWriteItem`` TODO
+- ``Query`` WIP
+- ``Scan`` WIP
+
+There is basically no support for ``Limit``, ``ExclusiveStartKey``,
+``ScanIndexForward`` and their associated features at all in ddbmock. This
+affects all "WIP" functions.
+
+``UpdateItem`` has a different behavior when the target item did not exist prior
+the update operation. In particular, the ``ADD`` operator will always behave as
+though the item existed before.
+
+Comparison Operators
+====================
+
+Some comparison might not work as expected on binary data as it is performed on
+the base64 representation instead of the binary one. Please report a bug if this
+is a problem for you, or, even better, open a pull request :)
+
+Common to ``Query`` and ``Scan``
+--------------------------------
+
+Specific to ``Scan``
+--------------------
+
+
+Rates and size limitations
+==========================
+
+basically, none are supported yet
+
+Request rate
+------------
+
+- Throttle read  operations when provisioned throughput exceeded. TODO
+- Throttle write operations when provisioned throughput exceeded. TODO
+- Report accurate throughput. WONT FIX
+
+ddbmock currently reports the consumed throughput based on item count. Their
+size is ignored from the computation. While it is theoretically possible, it
+would no be accurate anyway because we can not reproduce exactly Amazon's storage
+efficiency.
+
+Actually, this is even trickier as the throughput is normally spreaded among
+partitions which ddbmock does not handle.
+
+Request size
+------------
+
+- Limit response size to 1MB. TODO
+- Limit request size to 1MB. TODO
+- Limit ``BatchGetItem`` to 100 per request. TODO
+- Linit ``BatchWriteItem`` to 25 per request. TODO
+
+Table managment
+---------------
+
+- No more than 10 ``CREATING`` tables. TODO
+- No more than 10 ``DELETING`` tables. TODO
+- No more than 1  ``UPDATING`` table.  TODO
+
+- No more than 1 Throughput decrease/day. DONE
+- No more than *2 Throughput increase/day. DONE
     Programming Language :: Python :: 2.7
     License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
 requires-dist =
+    Sphinx
 
 [nosetests]
 where = ddbmock