⚠️ NO LONGER MAINTAINED ⚠️

This library is end-of-life and no longer supported.

This repository will not be updated. The repository will be kept available in read-only mode.

Please see the Migration Guide for advice about migrating to our replacement library cloudant-python-sdk.

For FAQs and additional information please refer to the Cloudant blog.

Cloudant Python Client

This is the official Cloudant library for Python.

• Installation and Usage
• Getting Started
• API Reference
• Related Documentation
• Development
  • Contributing
  • Test Suite
  • Using in Other Projects
  • License
  • Issues
• Migrating to cloudant-python-sdk library

Installation and Usage

Released versions of this library are hosted on PyPI and can be installed with pip.

In order to install the latest version, execute

pip install cloudant

Getting started

See Getting started (readthedocs.io)

API Reference

See API reference docs (readthedocs.io)

Related Documentation

• Cloudant Python client library docs (readthedocs.io)
• Cloudant documentation
• Cloudant Learning Center
• Tutorial for creating and populating a database on IBM Cloud

Development

See CONTRIBUTING.md

Using in other projects

The preferred approach for using python-cloudant in other projects is to use the PyPI as described above.

Examples in open source projects

Getting Started with Python Flask on IBM Cloud

Movie Recommender Demo:

• Update and check if documents exist
• Connect to Cloudant using 429 backoff with 10 retries

Watson Recipe Bot:

• Use Cloudant Query to find design docs

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.

Issues

Before opening a new issue please consider the following:

• Only the latest release is supported. If at all possible please try to reproduce the issue using the latest version.
• Please check the existing issues to see if the problem has already been reported. Note that the default search includes only open issues, but it may already have been closed.
• Cloudant customers should contact Cloudant support for urgent issues.
• When opening a new issue here in github please complete the template fully.

Migrating to cloudant-python-sdk library

We have a newly supported Cloudant Python SDK named cloudant-python-sdk. For advice on migrating from this module see MIGRATION.md.