[Python-modules-commits] [tinydb] 01/03: Import tinydb_3.2.1.orig.tar.gz
Adrian Alves
alvesadrian-guest at moszumanska.debian.org
Thu Aug 11 02:54:38 UTC 2016
This is an automated email from the git hooks/post-receive script.
alvesadrian-guest pushed a commit to tag debian/unknown
in repository tinydb.
commit d1c66cc614122549315a88f1cd4b038f06ca231c
Author: Adrian Alves <aalves at gmail.com>
Date: Wed Aug 10 23:44:35 2016 -0300
Import tinydb_3.2.1.orig.tar.gz
---
CONTRIBUTING.rst | 49 +++
LICENCE | 7 +
README.rst | 386 +++++++++++++++++++++
artwork/logo.png | Bin 0 -> 3298 bytes
artwork/logo.svg | 63 ++++
docs/.gitignore | 1 +
docs/Makefile | 177 ++++++++++
docs/_static/logo.png | Bin 0 -> 3298 bytes
docs/_templates/links.html | 7 +
docs/_templates/sidebarlogo.html | 3 +
docs/_themes/.gitignore | 3 +
docs/_themes/LICENSE | 37 +++
docs/_themes/README | 31 ++
docs/_themes/flask/layout.html | 30 ++
docs/_themes/flask/page.html | 18 +
docs/_themes/flask/relations.html | 17 +
docs/_themes/flask/static/flasky.css_t | 592 +++++++++++++++++++++++++++++++++
docs/_themes/flask/theme.conf | 4 +
docs/_themes/flask_theme_support.py | 86 +++++
docs/api.rst | 101 ++++++
docs/changelog.rst | 219 ++++++++++++
docs/conf.py | 272 +++++++++++++++
docs/contribute.rst | 49 +++
docs/extend.rst | 178 ++++++++++
docs/extensions.rst | 52 +++
docs/getting-started.rst | 107 ++++++
docs/index.rst | 49 +++
docs/intro.rst | 55 +++
docs/make.bat | 242 ++++++++++++++
docs/upgrade.rst | 50 +++
docs/usage.rst | 462 +++++++++++++++++++++++++
setup.py | 46 +++
tests/__init__.py | 0
tests/conftest.py | 19 ++
tests/test_middlewares.py | 99 ++++++
tests/test_operations.py | 17 +
tests/test_queries.py | 300 +++++++++++++++++
tests/test_storages.py | 105 ++++++
tests/test_tables.py | 76 +++++
tests/test_tinydb.py | 454 +++++++++++++++++++++++++
tests/test_utils.py | 121 +++++++
tinydb/__init__.py | 30 ++
tinydb/database.py | 470 ++++++++++++++++++++++++++
tinydb/middlewares.py | 116 +++++++
tinydb/operations.py | 28 ++
tinydb/queries.py | 342 +++++++++++++++++++
tinydb/storages.py | 128 +++++++
tinydb/utils.py | 140 ++++++++
48 files changed, 5838 insertions(+)
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 0000000..5fe243d
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,49 @@
+Contribution Guidelines
+#######################
+
+Whether reporting bugs, discussing improvements and new ideas or writing
+extensions: Contributions to TinyDB are welcome! Here's how to get started:
+
+1. Check for open issues or open a fresh issue to start a discussion around
+ a feature idea or a bug
+2. Fork `the repository <https://github.com/msiemens/tinydb/>`_ on GitHub,
+ create a new branch off the `master` branch and start making your changes
+ (known as `GitHub Flow <https://guides.github.com/introduction/flow/index.html>`_)
+3. Write a test which shows that the bug was fixed or that the feature works
+ as expected
+4. Send a pull request and bug the maintainer until it gets merged and
+ published :)
+
+Philosophy of TinyDB
+********************
+
+TinyDB aims to be simple and fun to use. Therefore two key values are simplicity
+and elegance of interfaces and code. These values will contradict each other
+from time to time. In these cases , try using as little magic as possible.
+In any case don't forget documenting code that isn't clear at first glance.
+
+Code Conventions
+****************
+
+In general the TinyDB source should always follow `PEP 8 <http://legacy.python.org/dev/peps/pep-0008/>`_.
+Exceptions are allowed in well justified and documented cases. However we make
+a small exception concerning docstrings:
+
+When using multiline docstrings, keep the opening and closing triple quotes
+on their own lines and add an empty line after it.
+
+.. code-block:: python
+
+ def some_function():
+ """
+ Documentation ...
+ """
+
+ # implementation ...
+
+Version Numbers
+***************
+
+TinyDB follows the `SemVer versioning guidelines <http://semver.org/>`_.
+This implies that backwards incompatible changes in the API will increment
+the major version. So think twice before making such changes.
diff --git a/LICENCE b/LICENCE
new file mode 100644
index 0000000..611d356
--- /dev/null
+++ b/LICENCE
@@ -0,0 +1,7 @@
+Copyright (C) 2013 Markus Siemens <markus at m-siemens.de>
+
+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/README.rst b/README.rst
new file mode 100644
index 0000000..1b2e51e
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,386 @@
+.. image:: artwork/logo.png
+ :scale: 100%
+ :height: 150px
+
+|Build Status| |Coverage| |Version|
+
+TinyDB is a lightweight document oriented database optimized for your happiness :)
+It's written in pure Python and has no external dependencies. The target are
+small apps that would be blown away by a SQL-DB or an external database server.
+
+TinyDB is:
+
+- **tiny:** The current source code has 1200 lines of code (with about 40%
+ documentation) and 1000 lines tests. For comparison: Buzhug_ has about 2500
+ lines of code (w/o tests), CodernityDB_ has about 7000 lines of code
+ (w/o tests).
+
+- **document oriented:** Like MongoDB_, you can store any document
+ (represented as ``dict``) in TinyDB.
+
+- **optimized for your happiness:** TinyDB is designed to be simple and
+ fun to use by providing a simple and clean API.
+
+- **written in pure Python:** TinyDB neither needs an external server (as
+ e.g. `PyMongo <http://api.mongodb.org/python/current/>`_) nor any dependencies
+ from PyPI.
+
+- **works on Python 2.6 – 3.5 and PyPy:** TinyDB works on all modern versions
+ of Python and PyPy.
+
+- **powerfully extensible:** You can easily extend TinyDB by writing new
+ storages or modify the behaviour of storages with Middlewares.
+
+- **100% test coverage:** No explanation needed.
+
+To dive straight into all the details, head over to the `TinyDB docs
+<https://tinydb.readthedocs.io/>`_. You can also discuss everything related
+to TinyDB like general development, extensions or showcase your TinyDB-based
+projects on the `discussion forum <http://forum.m-siemens.de/.>`_.
+
+
+Example Code
+************
+
+.. code-block:: python
+
+ >>> from tinydb import TinyDB, where
+ >>> db = TinyDB('/path/to/db.json')
+ >>> db.insert({'int': 1, 'char': 'a'})
+ >>> db.insert({'int': 1, 'char': 'b'})
+
+Query Language
+==============
+
+.. code-block:: python
+
+ >>> User = Query()
+ >>> # Search for a field value
+ >>> db.search(User.name == 'John')
+ [{'name': 'John', 'age': 22}, {'name': 'John', 'age': 37}]
+
+ >>> # Combine two queries with logical and
+ >>> db.search((User.name == 'John') & (User.age <= 30))
+ [{'name': 'John', 'age': 22}]
+
+ >>> # Combine two queries with logical or
+ >>> db.search((User.name == 'John') | (User.name == 'Bob'))
+ [{'name': 'John', 'age': 22}, {'name': 'John', 'age': 37}, {'name': 'Bob', 'age': 42}]
+
+ >>> # More possible comparisons: != < > <= >=
+ >>> # More possible checks: where(...).matches(regex), where(...).test(your_test_func)
+
+Tables
+======
+
+.. code-block:: python
+
+ >>> table = db.table('name')
+ >>> table.insert({'value': True})
+ >>> table.all()
+ [{'value': True}]
+
+Using Middlewares
+=================
+
+.. code-block:: python
+
+ >>> from tinydb.storages import JSONStorage
+ >>> from tinydb.middlewares import CachingMiddleware
+ >>> db = TinyDB('/path/to/db.json', storage=CachingMiddleware(JSONStorage))
+
+
+Supported Python Versions
+*************************
+
+TinyDB has been tested with Python 2.6, 2.7, 3.2 - 3.5 and PyPy.
+
+
+Extensions
+**********
+
+| **Name:** ``tinyindex``
+| **Repo:** https://github.com/eugene-eeo/tinyindex
+| **Status:** *experimental*
+| **Description:** Document indexing for TinyDB. Basically ensures deterministic
+ (as long as there aren't any changes to the table) yielding
+ of documents.
+
+|
+
+| **Name:** ``tinymongo``
+| **Repo:** https://github.com/schapman1974/tinymongo
+| **Status:** *experimental*
+| **Description:** A simple wrapper that allows to use TinyDB as a flat file
+ drop-in replacement for MongoDB.
+
+|
+
+| **Name:** ``tinyrecord``
+| **Repo:** https://github.com/eugene-eeo/tinyrecord
+| **Status:** *stable*
+| **Description:** Tinyrecord is a library which implements experimental atomic
+ transaction support for the TinyDB NoSQL database. It uses a
+ record-first then execute architecture which allows us to
+ minimize the time that we are within a thread lock.
+|
+
+| **Name:** ``tinydb-serialization``
+| **Repo:** https://github.com/msiemens/tinydb-serialization
+| **Status:** *stable*
+| **Description:** ``tinydb-serialization`` provides serialization for objects
+ that TinyDB otherwise couldn't handle.
+
+|
+
+| **Name:** ``tinydb-smartcache``
+| **Repo:** https://github.com/msiemens/tinydb-smartcache
+| **Status:** *stable*
+| **Description:** ``tinydb-smartcache`` provides a smart query cache for
+ TinyDB. It updates the query cache when
+ inserting/removing/updating elements so the cache doesn't
+ get invalidated. It's useful if you perform lots of queries
+ while the data changes only little.
+
+
+Contributing
+************
+
+Whether reporting bugs, discussing improvements and new ideas or writing
+extensions: Contributions to TinyDB are welcome! Here's how to get started:
+
+1. Check for open issues or open a fresh issue to start a discussion around
+ a feature idea or a bug
+2. Fork `the repository <https://github.com/msiemens/tinydb/>`_ on Github,
+ create a new branch off the `master` branch and start making your changes
+ (known as `GitHub Flow <https://guides.github.com/introduction/flow/index.html>`_)
+3. Write a test which shows that the bug was fixed or that the feature works
+ as expected
+4. Send a pull request and bug the maintainer until it gets merged and
+ published ☺
+
+
+Changelog
+*********
+
+**v3.2.0** (2016-06-29)
+=======================
+
+- Fix a bug with queries on elements that have a ``path`` key
+ (see `pull request #107 <https://github.com/msiemens/tinydb/pull/107>`_).
+
+**v3.2.0** (2016-04-25)
+=======================
+
+- Add a way to specify the default table name via `default_table <http://tinydb.readthedocs.io/en/v3.2.0/usage.html#default-table>`_
+ (see `pull request #98 <https://github.com/msiemens/tinydb/pull/98>`_).
+- Add ``db.purge_table(name)`` to remove a single table
+ (see `pull request #100 <https://github.com/msiemens/tinydb/pull/100>`_).
+
+ - Along the way: celebrating 100 issues and pull requests! Thanks everyone for every single contribution!
+
+- Extend API documentation (see `issue #96 <https://github.com/msiemens/tinydb/issues/96>`_).
+
+**v3.1.3** (2016-02-14)
+=======================
+
+- Fix a bug when that breaks the JSONStorage when the ``TinyDB`` instance gets garbagge collected
+ (see `issue #92 <https://github.com/msiemens/tinydb/issues/92>`_).
+
+**v3.1.2** (2016-01-30)
+=======================
+
+- Fix a bug when using unhashable elements (lists, dicts) with
+ ``Query.any`` or ``Query.all`` queries
+ (see `a forum post by karibul <https://forum.m-siemens.de/d/4-error-with-any-and-all-queries>`_).
+
+**v3.1.1** (2016-01-23)
+=======================
+
+- Inserting a dictionary with data that is not JSON serializable doesn't
+ lead to corrupt files anymore (see `issue #89 <https://github.com/msiemens/tinydb/issues/89>`_).
+- Fix a bug in the LRU cache that may lead to an invalid query cache
+ (see `issue #87 <https://github.com/msiemens/tinydb/issues/87>`_).
+
+**v3.1.0** (2015-12-31)
+=======================
+
+- ``db.update(...)`` and ``db.remove(...)`` now return affected element IDs
+ (see `issue #83 <https://github.com/msiemens/tinydb/issues/83>`_).
+- Inserting an invalid element (i.e. not a ``dict``) now raises an error
+ instead of corrupting the database (see
+ `issue #74 <https://github.com/msiemens/tinydb/issues/74>`_).
+
+**v3.0.0** (2015-11-13)
+=======================
+
+- Overhauled Query model:
+
+ - ``where('...').contains('...')`` has been renamed to
+ ``where('...').search('...')``.
+ - Support for ORM-like usage:
+ ``User = Query(); db.find(User.name == 'John')``.
+ - ``where('foo')`` is an alias for ``Query().foo``.
+ - ``where('foo').has('bar')`` is replaced by either
+ ``where('foo').bar`` or ``Query().foo.bar``.
+
+ - In case the key is not a valid Python identifier, array
+ notation can be used: ``where('a.b.c')`` is now
+ ``Query()['a.b.c']``.
+
+ - Checking for the existence of a key has to be done explicitely:
+ ``where('foo').exists()``.
+
+- Migrations from v1 to v2 have been removed.
+- ``SmartCacheTable`` has been moved to `msiemens/tinydb-smartcache`_.
+- Serialization has been moved to `msiemens/tinydb-serialization`_.
+- Empty storages are now expected to return ``None`` instead of raising ``ValueError``.
+ (see `issue #67 <https://github.com/msiemens/tinydb/issues/67>`_.
+
+.. _msiemens/tinydb-smartcache: https://github.com/msiemens/tinydb-smartcache
+.. _msiemens/tinydb-serialization: https://github.com/msiemens/tinydb-serialization
+
+**v2.4.0** (2015-08-14)
+=======================
+
+- Allow custom parameters for custom test functions
+ (see `issue #63 <https://github.com/msiemens/tinydb/issues/63>`_ and
+ `pull request #64 <https://github.com/msiemens/tinydb/pull/64>`_).
+
+**v2.3.2** (2015-05-20)
+=======================
+
+- Fix a forgotten debug output in the ``SerializationMiddleware``
+ (see `issue #55 <https://github.com/msiemens/tinydb/issues/55>`_).
+- Fix an "ignored exception" warning when using the ``CachingMiddleware``
+ (see `pull request #54 <https://github.com/msiemens/tinydb/pull/54>`_)
+- Fix a problem with symlinks when checking out TinyDB on OSX Yosemite
+ (see `issue #52 <https://github.com/msiemens/tinydb/issues/52>`_).
+
+**v2.3.1** (2015-04-30)
+=======================
+
+- Hopefully fix a problem with using TinyDB as a dependency in a ``setup.py`` script
+ (see `issue #51 <https://github.com/msiemens/tinydb/issues/51>`_).
+
+**v2.3.0** (2015-04-08)
+=======================
+
+- Added support for custom serialization. That way, you can teach TinyDB
+ to store ``datetime`` objects in a JSON file :)
+ (see `issue #48 <https://github.com/msiemens/tinydb/issues/48>`_ and
+ `pull request #50 <https://github.com/msiemens/tinydb/pull/50>`_)
+- Fixed a performance regression when searching became slower with every search
+ (see `issue #49 <https://github.com/msiemens/tinydb/issues/49>`_)
+- Internal code has been cleaned up
+
+**v2.2.2** (2015-02-12)
+=======================
+
+- Fixed a data loss when using ``CachingMiddleware`` together with ``JSONStorage``
+ (see `issue #47 <https://github.com/msiemens/tinydb/issues/47>`_)
+
+**v2.2.1** (2015-01-09)
+=======================
+
+- Fixed handling of IDs with the JSON backend that converted integers
+ to strings (see `issue #45 <https://github.com/msiemens/tinydb/issues/45>`_)
+
+**v2.2.0** (2014-11-10)
+=======================
+
+- Extended ``any`` and ``all`` queries to take lists as conditions
+ (see `pull request #38 <https://github.com/msiemens/tinydb/pull/38>`_)
+- Fixed an ``decode error`` when installing TinyDB in a non-UTF-8 environment
+ (see `pull request #37 <https://github.com/msiemens/tinydb/pull/37>`_)
+- Fixed some issues with ``CachingMiddleware`` in combination with
+ ``JSONStorage`` (see `pull request #39 <https://github.com/msiemens/tinydb/pull/39>`_)
+
+**v2.1.0** (2014-10-14)
+=======================
+
+- Added ``where(...).contains(regex)``
+ (see `issue #32 <https://github.com/msiemens/tinydb/issues/32>`_)
+- Fixed a bug that corrupted data after reopening a database
+ (see `issue #34 <https://github.com/msiemens/tinydb/issues/34>`_)
+
+**v2.0.1** (2014-09-22)
+=======================
+
+- Fixed handling of Unicode data in Python 2
+ (see `issue #28 <https://github.com/msiemens/tinydb/issues/28>`_).
+
+**v2.0.0** (2014-09-05)
+=======================
+
+`Upgrade Notes <http://tinydb.readthedocs.io/en/v2.0/upgrade.html#upgrade-v2-0>`_
+
+**Warning:** TinyDB changed the way data is stored. You may need to migrate
+your databases to the new scheme. Check out the `Upgrade Notes <http://tinydb.readthedocs.io/en/v2.0/upgrade.html#upgrade-v2-0>`_
+for details.
+
+- The syntax ``query in db`` has been removed, use ``db.contains`` instead.
+- The ``ConcurrencyMiddleware`` has been removed due to a insecure implementation
+ (see `Issue #18 <https://github.com/msiemens/tinydb/issues/18>`_). Consider
+ `tinyrecord <http://tinydb.readthedocs.io/en/v2.0/extensions.html#tinyrecord>`_ instead.
+
+- Better support for working with `Element IDs <http://tinydb.readthedocs.io/en/v2.0.0/usage.html#using-element-ids>`_.
+- Added support for `nested comparisons <http://tinydb.readthedocs.io/en/v2.0.0/usage.html#nested-queries>`_.
+- Added ``all`` and ``any`` `comparisons on lists <http://tinydb.readthedocs.io/en/v2.0.0/usage.html#nested-queries>`_.
+- Added optional `smart query caching <http://tinydb.readthedocs.io/en/v2.0.0/usage.html#smart-query-cache>`_.
+- The query cache is now a `fixed size LRU cache <http://tinydb.readthedocs.io/en/v2.0.0/usage.html#query-caching>`_.
+
+**v1.4.0** (2014-07-22)
+=======================
+
+- Added ``insert_multiple`` function
+ (see `issue #8 <https://github.com/msiemens/tinydb/issues/8>`_).
+
+**v1.3.0** (2014-07-02)
+=======================
+
+- Fixed `bug #7 <https://github.com/msiemens/tinydb/issues/7>`_: IDs not unique.
+- Extended the API: ``db.count(where(...))`` and ``db.contains(where(...))``.
+- The syntax ``query in db`` is now **deprecated** and replaced
+ by ``db.contains``.
+
+**v1.2.0** (2014-06-19)
+=======================
+
+- Added ``update`` method
+ (see `issue #6 <https://github.com/msiemens/tinydb/issues/6>`_).
+
+**v1.1.1** (2014-06-14)
+=======================
+
+- Merged `PR #5 <https://github.com/msiemens/tinydb/pull/5>`_: Fix minor
+ documentation typos and style issues.
+
+**v1.1.0** (2014-05-06)
+=======================
+
+- Improved the docs and fixed some typos.
+- Refactored some internal code.
+- Fixed a bug with multiple ``TinyDB?`` instances.
+
+**v1.0.1** (2014-04-26)
+=======================
+
+- Fixed a bug in ``JSONStorage`` that broke the database when removing entries.
+
+**v1.0.0** (2013-07-20)
+=======================
+
+- First official release – consider TinyDB stable now.
+
+
+
+.. |Build Status| image:: http://img.shields.io/travis/msiemens/tinydb.svg?style=flat-square
+ :target: https://travis-ci.org/msiemens/tinydb
+.. |Coverage| image:: http://img.shields.io/coveralls/msiemens/tinydb.svg?style=flat-square
+ :target: https://coveralls.io/r/msiemens/tinydb
+.. |Version| image:: http://img.shields.io/pypi/v/tinydb.svg?style=flat-square
+ :target: https://pypi.python.org/pypi/tinydb/
+.. _Buzhug: http://buzhug.sourceforge.net/
+.. _CodernityDB: http://labs.codernity.com/codernitydb/
+.. _MongoDB: http://mongodb.org/
diff --git a/artwork/logo.png b/artwork/logo.png
new file mode 100644
index 0000000..7e422a1
Binary files /dev/null and b/artwork/logo.png differ
diff --git a/artwork/logo.svg b/artwork/logo.svg
new file mode 100644
index 0000000..bb439cc
--- /dev/null
+++ b/artwork/logo.svg
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 16.0.3, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" id="Ebene_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+ width="304px" height="99px" viewBox="0 0 304 99" enable-background="new 0 0 304 99" xml:space="preserve">
+<g id="Documents">
+ <rect x="14.5" y="21.5" fill="#343F4A" stroke="#000000" stroke-miterlimit="10" width="50" height="66"/>
+ <rect x="7.5" y="15.5" fill="#587896" stroke="#3C5166" stroke-miterlimit="10" width="50" height="66"/>
+</g>
+<g>
+ <path fill="#282E33" d="M99.439,74.389h-9.99V35.588H76.655v-8.314h35.578v8.314H99.439V74.389z"/>
+ <path fill="#282E33" d="M116.642,29.046c0-3.201,1.783-4.802,5.35-4.802c3.566,0,5.35,1.601,5.35,4.802
+ c0,1.526-0.446,2.712-1.337,3.561c-0.892,0.849-2.229,1.273-4.012,1.273C118.425,33.88,116.642,32.269,116.642,29.046z
+ M126.89,74.389h-9.829V38.359h9.829V74.389z"/>
+ <path fill="#282E33" d="M168.81,74.389h-9.829V53.345c0-2.599-0.462-4.549-1.386-5.849c-0.924-1.3-2.396-1.95-4.415-1.95
+ c-2.75,0-4.737,0.918-5.962,2.755s-1.837,4.882-1.837,9.136v16.951h-9.829V38.359h7.509l1.321,4.608h0.548
+ c1.096-1.74,2.605-3.056,4.528-3.948c1.922-0.891,4.109-1.337,6.558-1.337c4.189,0,7.369,1.133,9.539,3.4
+ c2.17,2.267,3.255,5.538,3.255,9.813V74.389z"/>
+ <path fill="#282E33" d="M172.123,38.359h10.764l6.8,20.271c0.58,1.762,0.978,3.846,1.192,6.252h0.193
+ c0.236-2.212,0.698-4.297,1.386-6.252l6.671-20.271h10.538l-15.243,40.638c-1.397,3.759-3.389,6.574-5.978,8.443
+ c-2.589,1.869-5.613,2.804-9.072,2.804c-1.697,0-3.363-0.183-4.995-0.548v-7.799c1.181,0.279,2.47,0.419,3.867,0.419
+ c1.74,0,3.26-0.532,4.56-1.595c1.3-1.063,2.315-2.67,3.045-4.818l0.58-1.772L172.123,38.359z"/>
+ <path fill="#004B6B" d="M253.037,50.38c0,7.756-2.208,13.696-6.623,17.821s-10.791,6.188-19.126,6.188h-13.342V27.273h14.792
+ c7.691,0,13.664,2.03,17.918,6.091S253.037,43.097,253.037,50.38z M242.66,50.638c0-10.119-4.469-15.179-13.406-15.179h-5.317
+ v30.68h4.286C237.847,66.139,242.66,60.972,242.66,50.638z"/>
+ <path fill="#004B6B" d="M259.832,27.273h14.663c6.682,0,11.532,0.951,14.55,2.852c3.018,1.901,4.528,4.926,4.528,9.072
+ c0,2.815-0.661,5.124-1.982,6.929s-3.078,2.89-5.269,3.255v0.322c2.986,0.666,5.14,1.913,6.461,3.738
+ c1.321,1.826,1.982,4.254,1.982,7.283c0,4.297-1.552,7.649-4.657,10.055c-3.105,2.406-7.321,3.609-12.649,3.609h-17.628V27.273z
+ M269.822,45.933h5.801c2.707,0,4.667-0.419,5.881-1.257c1.213-0.838,1.821-2.224,1.821-4.157c0-1.805-0.661-3.099-1.982-3.883
+ c-1.321-0.784-3.411-1.176-6.268-1.176h-5.253V45.933z M269.822,53.86v12.278h6.51c2.75,0,4.78-0.526,6.091-1.579
+ c1.31-1.052,1.966-2.664,1.966-4.834c0-3.91-2.793-5.865-8.379-5.865H269.822z"/>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+</svg>
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 0000000..c6a151b
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1 @@
+_build/
\ No newline at end of file
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..f99b774
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# 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 " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @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 " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @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/TinyDB.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/TinyDB.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/TinyDB"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TinyDB"
+ @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."
+
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @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."
+
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644
index 0000000..7e422a1
Binary files /dev/null and b/docs/_static/logo.png differ
diff --git a/docs/_templates/links.html b/docs/_templates/links.html
new file mode 100644
index 0000000..6652681
--- /dev/null
+++ b/docs/_templates/links.html
@@ -0,0 +1,7 @@
+<h3>Useful Links</h3>
+<ul>
+ <li><a href="http://pypi.python.org/pypi/tinydb">TinyDB on PyPI</a></li>
+ <li><a href="http://github.com/msiemens/tinydb">TinyDB on GitHub</a></li>
+ <li><a href="http://github.com/msiemens/tinydb/issues">Issue Tracker</a></li>
+ <li><a href="http://forum.m-siemens.de">Discussion Forum</a></li>
+</ul>
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
new file mode 100644
index 0000000..ee33ad8
--- /dev/null
+++ b/docs/_templates/sidebarlogo.html
@@ -0,0 +1,3 @@
+<p class="logo"><a href="{{ pathto(master_doc) }}">
+<img class="logo" src="{{ pathto('_static/logo.png', 1) }}" alt="Logo"/>
+</a></p>
diff --git a/docs/_themes/.gitignore b/docs/_themes/.gitignore
new file mode 100644
index 0000000..66b6e4c
--- /dev/null
+++ b/docs/_themes/.gitignore
@@ -0,0 +1,3 @@
+*.pyc
+*.pyo
+.DS_Store
diff --git a/docs/_themes/LICENSE b/docs/_themes/LICENSE
new file mode 100644
index 0000000..8daab7e
--- /dev/null
+++ b/docs/_themes/LICENSE
@@ -0,0 +1,37 @@
+Copyright (c) 2010 by Armin Ronacher.
+
+Some rights reserved.
+
+Redistribution and use in source and binary forms of the theme, 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.
+
+* The names of the contributors may not be used to endorse or
+ promote products derived from this software without specific
+ prior written permission.
+
+We kindly ask you to only use these themes in an unmodified manner just
+for Flask and Flask-related products, not for unrelated projects. If you
+like the visual style and want to use it for your own projects, please
+consider making some larger changes to the themes (such as changing
+font faces, sizes, colors or margins).
+
+THIS THEME 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 THEME, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
diff --git a/docs/_themes/README b/docs/_themes/README
new file mode 100644
index 0000000..b3292bd
--- /dev/null
+++ b/docs/_themes/README
@@ -0,0 +1,31 @@
+Flask Sphinx Styles
+===================
+
+This repository contains sphinx styles for Flask and Flask related
+projects. To use this style in your Sphinx documentation, follow
+this guide:
+
+1. put this folder as _themes into your docs folder. Alternatively
+ you can also use git submodules to check out the contents there.
+2. add this to your conf.py:
+
+ sys.path.append(os.path.abspath('_themes'))
+ html_theme_path = ['_themes']
+ html_theme = 'flask'
+
+The following themes exist:
+
+- 'flask' - the standard flask documentation theme for large
+ projects
+- 'flask_small' - small one-page theme. Intended to be used by
+ very small addon libraries for flask.
+
+The following options exist for the flask_small theme:
+
+ [options]
+ index_logo = '' filename of a picture in _static
+ to be used as replacement for the
+ h1 in the index.rst file.
+ index_logo_height = 120px height of the index logo
+ github_fork = '' repository name on github for the
+ "fork me" badge
diff --git a/docs/_themes/flask/layout.html b/docs/_themes/flask/layout.html
new file mode 100644
index 0000000..cefafd2
--- /dev/null
+++ b/docs/_themes/flask/layout.html
@@ -0,0 +1,30 @@
+{%- extends "basic/layout.html" %}
+
+{%- block extrahead %}
+ {{ super() }}
+ {% if theme_touch_icon %}
+ <link rel="apple-touch-icon" href="{{ pathto('_static/' ~ theme_touch_icon, 1) }}" />
+ <link rel="icon" href="{{ pathto('_static/' ~ theme_touch_icon, 1) }}" type="image/png" />
+ {% endif %}
+ <link media="only screen and (max-width: 920px)" href="{{
+ pathto('_static/small_flask.css', 1) }}" type= "text/css" rel="stylesheet" />
+{% endblock %}
+
+{%- block relbar2 %}{% endblock %}
+
+{% block header %}
+ {{ super() }}
+ {% if pagename == 'index' %}
+ <div class=indexwrapper>
+ {% endif %}
+{% endblock %}
+
+ {%- block footer %}
+ <div class="footer">
+ © Copyright {{ copyright }}.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
+ </div>
+ {% if pagename == 'index' %}
+ </div>
+ {% endif %}
+{%- endblock %}
diff --git a/docs/_themes/flask/page.html b/docs/_themes/flask/page.html
new file mode 100644
index 0000000..d9a1a45
--- /dev/null
+++ b/docs/_themes/flask/page.html
@@ -0,0 +1,18 @@
+{%- extends "basic/page.html" %}
+
+{% block body %}
+ {{ super() }}
+
+ {%- if prev or next and pagename != 'index' %}
+ <p>
+ {%- if prev %}
+ <a href="{{ prev.link|e }}" title="{{ _('previous chapter')
+ }}">« {{ prev.title }}</a> {% if next %}|{% endif %}
+ {%- endif %}
+ {%- if next %}
+ <a href="{{ next.link|e }}" title="{{ _('next chapter')
+ }}">{{ next.title }} »</a>
+ {%- endif %}
+ </p>
+ {%- endif %}
+{% endblock %}
diff --git a/docs/_themes/flask/relations.html b/docs/_themes/flask/relations.html
new file mode 100644
index 0000000..9175427
--- /dev/null
+++ b/docs/_themes/flask/relations.html
@@ -0,0 +1,17 @@
+<h3>Navigation</h3>
+<ul>
+ {%- for parent in parents %}
+ <li><a href="{{ parent.link|e }}">{{ parent.title }}</a><ul>
+ {%- endfor %}
+ {%- if prev %}
+ <li>Previous: <a href="{{ prev.link|e }}" title="{{ _('previous chapter')
+ }}">{{ prev.title }}</a></li>
+ {%- endif %}
+ {%- if next %}
+ <li>Next: <a href="{{ next.link|e }}" title="{{ _('next chapter')
+ }}">{{ next.title }}</a></li>
+ {%- endif %}
+ {%- for parent in parents %}
+ </ul></li>
+ {%- endfor %}
+</ul>
diff --git a/docs/_themes/flask/static/flasky.css_t b/docs/_themes/flask/static/flasky.css_t
new file mode 100644
index 0000000..9d717fa
--- /dev/null
+++ b/docs/_themes/flask/static/flasky.css_t
@@ -0,0 +1,592 @@
+/*
+ * flasky.css_t
+ * ~~~~~~~~~~~~
+ *
+ * :copyright: Copyright 2010 by Armin Ronacher.
+ * :license: Flask Design License, see LICENSE for details.
+ */
+
+{% set page_width = '940px' %}
+{% set sidebar_width = '220px' %}
+{% set font_family = "'Open Sans', sans-serif" %}
+{% set monospace_font_family = "'Source Code Pro', 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace" %}
+{% set accent_color = '#2d4e84' %}{# original: #004B6B #}
+{% set accent_color_alternate = '#2069e1' %}{# original: #6D4100 #}
+
+ at import url(http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic|Source+Code+Pro);
... 5177 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/tinydb.git
More information about the Python-modules-commits
mailing list