Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ project:
- Handles the authentication.
- Familiar user experience with IBM Cloud SDKs.
- Flexibility to use either built-in models or byte-based requests and responses for documents.
- Built-in [Changes feed follower](./docs/Changes_Follower.md)
- Built-in [Pagination](./docs/Pagination.md) (beta)
- Built-in [Changes feed follower](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Changes_Follower.md)
- Built-in [Pagination](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Pagination.md) (beta)
- Instances of the client are unconditionally thread-safe.

## Prerequisites
Expand Down Expand Up @@ -103,16 +103,16 @@ account.

There are several ways to **set** these authentication properties:

1. As [environment variables](./docs/Authentication.md#authentication-with-environment-variables)
2. The [programmatic approach](./docs/Authentication.md#programmatic-authentication)
3. With an [external credentials file](./docs/Authentication.md#authentication-with-external-configuration)
1. As [environment variables](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Authentication.md#authentication-with-environment-variables)
2. The [programmatic approach](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Authentication.md#programmatic-authentication)
3. With an [external credentials file](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Authentication.md#authentication-with-external-configuration)

The following section describes the different authentication types and provides environment variable examples.
Examples for other configuration methods are available by following the provided links.

### Authentication

Consult the [authentication document](./docs/Authentication.md)
Consult the [authentication document](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Authentication.md)
for comprehensive details of all the available authentication methods and how to configure them with environment settings
or programmatically.

Expand Down Expand Up @@ -158,7 +158,7 @@ response = service.get_all_dbs().get_result()
print(response)
```

[More tutorial examples](./docs/Examples.md) for creating a database
[More tutorial examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Examples.md) for creating a database
and document create, read, update and delete operations.

For a complete list of code examples, see the [examples directory](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/examples#examples-for-python).
Expand All @@ -184,7 +184,7 @@ Response byte stream is supported in functions with the suffix of `_as_stream`.
The returned byte stream allows the response body to be consumed
without triggering JSON unmarshalling that is typically performed by the SDK.

The [update document](./docs/Examples.md#3-update-your-previously-created-document) section
The [update document](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Examples.md#3-update-your-previously-created-document) section
contains examples for both request and response byte stream cases.

The API reference contains further examples of using byte streams.
Expand Down Expand Up @@ -294,7 +294,7 @@ print(response)

### Further resources

- [Cloudant Python SDK feature docs](./docs)
- [Cloudant Python SDK feature docs](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs)
- [Cloudant API docs](https://cloud.ibm.com/apidocs/cloudant?code=python):
API reference including usage examples for Cloudant Python SDK API.
- [Pydoc](https://ibm.github.io/cloudant-python-sdk/):
Expand Down
4 changes: 2 additions & 2 deletions docs/Changes_Follower.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The changes follower requires the client to have HTTP timeouts of at least 1 min
instantiation if it is insufficient. The default client configuration has sufficiently long timeouts.

For use-cases where these configuration limitations are too restrictive then write code to use the SDK's
[POST `_changes` API](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/examples#postchanges) instead of the follower.
[POST `_changes` API](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/examples#postchanges) instead of the follower.

## Error suppression

Expand Down Expand Up @@ -101,7 +101,7 @@ The follower is not optimized for some use cases and it is not recommended to us
* Setting `include_docs` and larger document sizes (for example > 10 kiB).
* The volume of changes is very high (if the rate of changes in the database exceeds the follower's rate of pulling them it can never catch-up).

In these use-cases use the SDK's [POST `_changes` API](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/examples#postchanges)
In these use-cases use the SDK's [POST `_changes` API](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/examples#postchanges)
for specific control over the number of change requests made and the content size of the responses.

## Checkpoints
Expand Down
2 changes: 1 addition & 1 deletion docs/Examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,4 +324,4 @@ You have deleted the document.

## Further code examples

For a complete list of code examples, see the [examples directory](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/examples#examples-for-python).
For a complete list of code examples, see the [examples directory](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/examples#examples-for-python).
18 changes: 9 additions & 9 deletions docs/Pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,22 +71,22 @@ then a `429 Too Many Requests` error occurs.
Pagination is available for these operations:
* Query all documents [global](https://cloud.ibm.com/apidocs/cloudant?code=python#postalldocs)
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=python#postpartitionalldocs)
* [Global all documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/AllDocsPagination.py)
* [Partitioned all documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/partition_all_docs_pagination.py)
* [Global all documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/AllDocsPagination.py)
* [Partitioned all documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/partition_all_docs_pagination.py)
* Query all [design documents](https://cloud.ibm.com/apidocs/cloudant?code=python#postdesigndocs)
* [Design documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/design_docs_pagination.py)
* [Design documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/design_docs_pagination.py)
* Query with selector syntax [global](https://cloud.ibm.com/apidocs/cloudant?code=python#postfind)
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=python#postpartitionfind)
* [Global find selector query examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/find_pagination.py)
* [Partitioned find selector query examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/partition_find_pagination.py)
* [Global find selector query examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/find_pagination.py)
* [Partitioned find selector query examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/partition_find_pagination.py)
* Query a search index [global](https://cloud.ibm.com/apidocs/cloudant?code=python#postsearch)
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=python#postpartitionsearch)
* [Global search examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/search_pagination.py)
* [Partitioned search examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/partition_search_pagination.py)
* [Global search examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/search_pagination.py)
* [Partitioned search examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/partition_search_pagination.py)
* Query a MapReduce view [global](https://cloud.ibm.com/apidocs/cloudant?code=python#postview)
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=python#postpartitionview)
* [Global view examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/view_pagination.py)
* [Partitioned view examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/partition_view_pagination.py)
* [Global view examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/view_pagination.py)
* [Partitioned view examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/partition_view_pagination.py)

The examples presented in this `README` are for all documents in a partition.
The links in the list are to equivalent examples for each of the other available operations.
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# IBM Cloudant Python SDK Version 0.10.5 Detailed Documentation
# IBM Cloudant Python SDK Version 0.10.6 Detailed Documentation

## Table of Contents

Expand Down
Loading