cloudant 2.0.3

Cloudant / CouchDB Client Library

Cloudant Python Client
======================

|build-status| |docs| |compatibility|

.. |build-status| image:: https://travis-ci.org/cloudant/python-cloudant.png
:alt: build status
:scale: 100%
:target: https://travis-ci.org/cloudant/python-cloudant

.. |docs| image:: https://readthedocs.org/projects/pip/badge/
:alt: docs
:scale: 100%
:target: http://python-cloudant.readthedocs.io

.. |compatibility| image:: https://img.shields.io/badge/python-2.7%2C%203.5-blue.svg
:alt: compatibility
:scale: 100%
:target: http://python-cloudant.readthedocs.io/en/latest/compatibility.html

This is the official Cloudant library for Python.

.. contents::
:local:
:depth: 2
:backlinks: none

======================
Installation and Usage
======================

Released versions of this library are `hosted on PyPI <https://pypi.python.org/pypi/cloudant>`_
and can be installed with ``pip``.

In order to install the latest version, execute

.. code-block:: bash

pip install cloudant

===============
Getting started
===============

See `Getting started (readthedocs.io) <http://python-cloudant.readthedocs.io/en/latest/getting_started.html>`_

=============
API Reference
=============

See `API reference docs (readthedocs.io) <http://python-cloudant.readthedocs.io/en/latest/cloudant.html>`_

=====================
Related Documentation
=====================

* `Cloudant Python client library docs (readthedocs.io) <http://python-cloudant.readthedocs.io>`_
* `Cloudant documentation <http://docs.cloudant.com/>`_
* `Cloudant for developers <https://cloudant.com/for-developers/>`_

===========
Development
===========

See `CONTRIBUTING.rst <https://github.com/cloudant/python-cloudant/blob/master/CONTRIBUTING.rst>`_

**********
Test Suite
**********

Content coming soon...

***********************
Using in other projects
***********************

Content coming soon...

*******
License
*******

Copyright © 2015 IBM. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.