Metadata-Version: 2.0
Name: time2relax
Version: 0.3.0
Summary: A CouchDB driver for Python.
Home-page: https://github.com/rwanyoike/time2relax
Author: Raymond Wanyoike
Author-email: raymond.wanyoike@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: requests
Requires-Dist: six

time2relax - Python CouchDB driver
==================================

|PyPI version| |Build status| |Coverage status| |Documentation status|

A `CouchDB`_ driver for Python.

* Documentation: https://time2relax.readthedocs.org.
* Free software: MIT license

.. |PyPI version| image:: https://img.shields.io/pypi/v/time2relax.svg
   :target: https://pypi.python.org/pypi/time2relax
.. |Build status| image:: https://img.shields.io/travis/rwanyoike/time2relax.svg
   :target: https://travis-ci.org/rwanyoike/time2relax
.. |Coverage status| image:: https://img.shields.io/codecov/c/gh/rwanyoike/time2relax.svg
   :target: https://codecov.io/gh/rwanyoike/time2relax
.. |Documentation status| image:: https://readthedocs.org/projects/time2relax/badge/?version=latest
   :target: https://readthedocs.org/projects/time2relax/?badge=latest
.. _CouchDB: http://couchdb.com/

Features
--------

* Runs `python-requests`_ under the hood.
* Only a minimum level of abstraction between you and CouchDB.
* Transparent URL and parameter encoding.
* Exceptions are modelled from CouchDB errors.
* Python 2.6–2.7 & 3.3–3.5 support.
* Tested with CouchDB 1.6.x (2.0?).

Inspired by `pouchdb`_ and `nano`_ APIs.

.. _python-requests: http://requests.readthedocs.io/en/latest/#supported-features
.. _pouchdb: https://github.com/pouchdb/pouchdb
.. _nano: https://github.com/dscape/nano

Quickstart
----------

Install the latest time2relax if you haven't yet:

.. code:: shell

    $ pip install -U time2relax

To use time2relax in a project:

.. code:: python

    >>> from time2relax import CouchDB
    >>> db = CouchDB('http://localhost:5984/dbname')

Then:

.. code:: python

    >>> db.insert({'title': 'Ziggy Stardust'})
    <Response [201]>


History
=======

0.3.0 (2017-03-03)
------------------

* Thin python-requests wrapper.
* New driver API.
* Add design document functions; list, show, view.

0.2.0 (2016-12-10)
------------------

* Python 3.3, 3.4, 3.5 support.

0.1.0 (2016-12-10)
------------------

* First release on PyPI.


