Pysyncgateway

-------------------

Added
.....

* Added support for Python 3.5+
* Removed support for Python 2
* Tested support for version 2.5.0 of Sync Gateway.

-------------------

Added
.....

* ``Document.get_open_revisions()`` added to load all leaf revisions of a
Document.

* ``Database.bulk_docs()`` added for updating multiple documents and deleting
open revisions.

-------------------

Added
.....

* Extended linting to include ``flake8-aaa`` to lint tests.

Changed
.......

* Bumped version of ``requests`` in requirements to ``2.19.1``, but kept
requirement in ``setup.py`` the same at ``>=2.18``.

* Improved output in stacktraces when ``RevisionMismatch`` is raised. Now
includes URL of resource and any revision number that was sent.

-------------------

Changed
.......

* Adjusted how provided ``key`` values are serialized when querying a view in a
Query design document. Now ``key`` values are serialized to JSON allowing for
multi-key views to be queried.

This is a breaking change because any single key value was previously
converted to a string before serialization to JSON. Now ``key`` is serialized
to JSON directly in ``Query.query_view()``.

-------------------

Stable release.

Added
.....

* Extended test suite to include initial smoke tests on Python 3 which assert
that package is installable.

-------------------

Added
.....

* ``Database.get_query()`` shortcut for loading Query documents.

* New ``Session`` class which operates on a Database. Additional
``Database.get_session()`` shortcut for loading Sessions.

Changed
.......

* Adjust Resource's data dict instance to raise ``InvalidDataKey`` rather than
``AssertionError`` when a prohibited key is added.

Internals
.........

* Module documentation added to git and RTD.

* Bandit to test security. As a result removed many uses of ``assert`` in code.

* Initialisation of Document and Database simplified.