Skip to main content

Cloudant / CouchDB Client Library

Project description

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

|build-status| |docs|

.. |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.org

This library is currently a preview (alpha version) of Cloudant's new official
Python library. As such it currently does not have complete API coverage nor is the
documentation 100% complete. We are busily working towards bridging the API and
documentation gaps, so please check back often as additions/changes will be
occuring frequently.

.. 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``.

The latest stable version on PyPI is 0.5.10, **but is now deprecated**.

The current development version, which you should now use, is 2.0.0a4. Version 2.x makes
significant breaking changes -- no attempt was made to reproduce the API of 0.5.10.

Because 2.0.0 is still in development (2.0.0a4) and we wish to give developers time to
upgrade, version 0.5.10 will remain the latest stable version on PyPI until at least early
2016.

In order to install version 2.0.0a1 or greater, execute

.. code-block:: bash

pip install --pre cloudant

In order to install the deprecated 0.5.10, execute

.. code-block:: bash

pip install cloudant

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

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

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

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

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

* `Cloudant Python client library docs (readthedocs.org) <http://python-cloudant.readthedocs.org>`_
* `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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloudant-2.0.0a4.tar.gz (26.1 kB view details)

Uploaded Source

Built Distribution

cloudant-2.0.0a4-py2-none-any.whl (36.2 kB view details)

Uploaded Python 2

File details

Details for the file cloudant-2.0.0a4.tar.gz.

File metadata

  • Download URL: cloudant-2.0.0a4.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for cloudant-2.0.0a4.tar.gz
Algorithm Hash digest
SHA256 24681a9892d87b7cbbc28b2c1ebda57fffbb4f843d6547810d3f360b3ead563e
MD5 b0fb186003b62a0d37bf3b4bcc6b7294
BLAKE2b-256 6b9177e7de3cb51f30efecf5de8a86dfd591e1a5d43e541e1acf7b2325e96278

See more details on using hashes here.

File details

Details for the file cloudant-2.0.0a4-py2-none-any.whl.

File metadata

File hashes

Hashes for cloudant-2.0.0a4-py2-none-any.whl
Algorithm Hash digest
SHA256 cc9f5c94dd90a6c292fa14b17455a2ce8aa4192107284bb8e1d0378c478c8e22
MD5 214e6da9f3c8616da3b5c88e8517e19a
BLAKE2b-256 91d47b497e85abaddddd8f3f7406ed25949bb7a5b4b53fb5c5f306f6fa12faa5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page