You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit bd57c3b
Browse filesBrowse the repository at this point in the historyBrowse files
- IBM Cloudant (Gen 2) - see [compatibility notes](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/KNOWN_ISSUES.md#cloudant-gen-2-compatibility).
63
+
- IBM Cloudant (Gen 2) - see [compatibility notes](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/KNOWN_ISSUES.md#cloudant-gen-2-compatibility).
64
64
-[Apache CouchDB 3.x](https://docs.couchdb.org/en/stable/) for data operations.
65
65
- Includes all the most popular and latest supported endpoints for
66
66
applications.
67
67
- Handles the authentication.
68
68
- Familiar user experience with IBM Cloud SDKs.
69
69
- Flexibility to use either built-in models or byte-based requests and responses for documents.
- Instances of the client are unconditionally thread-safe.
73
73
74
74
## Prerequisites
@@ -85,13 +85,13 @@ project:
85
85
To install, use `pip` or `easy_install`:
86
86
87
87
```bash
88
-
pip install --upgrade "ibmcloudant>=0.11.9"
88
+
pip install --upgrade "ibmcloudant>=0.11.10"
89
89
```
90
90
91
91
or
92
92
93
93
```bash
94
-
easy_install --upgrade "ibmcloudant>=0.11.9"
94
+
easy_install --upgrade "ibmcloudant>=0.11.10"
95
95
```
96
96
97
97
## Using the SDK
@@ -104,16 +104,16 @@ account.
104
104
105
105
There are several ways to **set** these authentication properties:
106
106
107
-
1. As [environment variables](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/docs/Authentication.md#authentication-with-environment-variables)
108
-
2. The [programmatic approach](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/docs/Authentication.md#programmatic-authentication)
109
-
3. With an [external credentials file](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/docs/Authentication.md#authentication-with-external-configuration)
107
+
1. As [environment variables](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/docs/Authentication.md#authentication-with-environment-variables)
108
+
2. The [programmatic approach](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/docs/Authentication.md#programmatic-authentication)
109
+
3. With an [external credentials file](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/docs/Authentication.md#authentication-with-external-configuration)
110
110
111
111
The following section describes the different authentication types and provides environment variable examples.
112
112
Examples for other configuration methods are available by following the provided links.
113
113
114
114
### Authentication
115
115
116
-
Consult the [authentication document](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/docs/Authentication.md)
116
+
Consult the [authentication document](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/docs/Authentication.md)
117
117
for comprehensive details of all the available authentication methods and how to configure them with environment settings
[More tutorial examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/docs/Examples.md) for creating a database
162
+
[More tutorial examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/docs/Examples.md) for creating a database
163
163
and document create, read, update and delete operations.
164
164
165
-
For a complete list of code examples, see the [examples directory](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/examples#examples-for-python).
165
+
For a complete list of code examples, see the [examples directory](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/examples#examples-for-python).
166
166
167
167
### Error handling
168
168
@@ -185,7 +185,7 @@ Response byte stream is supported in functions with the suffix of `_as_stream`.
185
185
The returned byte stream allows the response body to be consumed
186
186
without triggering JSON unmarshalling that is typically performed by the SDK.
187
187
188
-
The [update document](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/docs/Examples.md#3-update-your-previously-created-document) section
188
+
The [update document](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/docs/Examples.md#3-update-your-previously-created-document) section
189
189
contains examples for both request and response byte stream cases.
190
190
191
191
The API reference contains further examples of using byte streams.
@@ -318,7 +318,7 @@ If you encounter an issue with the project, you are welcome to submit a
318
318
319
319
Before you submit a bug report, search for
320
320
[similar issues](https://github.com/IBM/cloudant-python-sdk/issues?q=is%3Aissue) and review the
321
-
[KNOWN_ISSUES file](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/KNOWN_ISSUES.md) to verify that your issue hasn't been reported yet.
321
+
[KNOWN_ISSUES file](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/KNOWN_ISSUES.md) to verify that your issue hasn't been reported yet.
322
322
323
323
Please consult the [security policy](https://github.com/IBM/cloudant-python-sdk/security/policy) before opening security related issues.
324
324
@@ -348,8 +348,8 @@ Find more open source projects on the [IBM GitHub](http://ibm.github.io/) page.
348
348
349
349
## Contributing
350
350
351
-
For more information, see [CONTRIBUTING](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/CONTRIBUTING.md).
351
+
For more information, see [CONTRIBUTING](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/CONTRIBUTING.md).
352
352
353
353
## License
354
354
355
-
This SDK is released under the Apache 2.0 license. To read the full text of the license, see [LICENSE](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/LICENSE).
355
+
This SDK is released under the Apache 2.0 license. To read the full text of the license, see [LICENSE](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/LICENSE).
Copy file name to clipboardExpand all lines: docs/Examples.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -322,4 +322,4 @@ You have deleted the document.
322
322
323
323
## Further code examples
324
324
325
-
For a complete list of code examples, see the [examples directory](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/examples#examples-for-python).
325
+
For a complete list of code examples, see the [examples directory](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/examples#examples-for-python).
Copy file name to clipboardExpand all lines: docs/Pagination.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,22 +71,22 @@ then a `429 Too Many Requests` error occurs.
71
71
Pagination is available for these operations:
72
72
* Query all documents [global](https://cloud.ibm.com/apidocs/cloudant?code=python#postalldocs)
73
73
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=python#postpartitionalldocs)
74
-
*[Global all documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/test/examples/src/features/pagination/all_docs_pagination.py)
75
-
*[Partitioned all documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.9/test/examples/src/features/pagination/partition_all_docs_pagination.py)
74
+
*[Global all documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/test/examples/src/features/pagination/all_docs_pagination.py)
75
+
*[Partitioned all documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.11.10/test/examples/src/features/pagination/partition_all_docs_pagination.py)
76
76
* Query all [design documents](https://cloud.ibm.com/apidocs/cloudant?code=python#postdesigndocs)
0 commit comments