Description

[](https://github.com/IBM/python-sdk-core/actions/workflows/build.yaml) [](https://pypi.org/project/ibm-cloud-sdk-core/) [](https://pypi.python.org/pypi/ibm-cloud-sdk-core) [](https://cla-assistant.io/ibm/python-sdk-core) [](https://github.com/semantic-release/semantic-release) # IBM Python SDK Core Version 3.24.4 This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator (openapi-sdkgen). # Python Version The current minimum Python version supported is 3.10. ## Installation To install, use `pip`: ```bash python -m pip install --upgrade ibm-cloud-sdk-core ``` ## Authentication The python-sdk-core project supports the following types of authentication: - Basic Authentication - Bearer Token Authentication - Identity and Access Management (IAM) Authentication (grant type: apikey) - Identity and Access Management (IAM) Authentication (grant type: assume) - Container Authentication - VPC Instance Authentication - Cloud Pak for Data Authentication - No Authentication (for testing) For more information about the various authentication types and how to use them with your services, click [here](Authentication.md). ## Issues If you encounter an issue with this project, you are welcome to submit a [bug report](https://github.com/IBM/python-sdk-core/issues). Before opening a new issue, please search for similar issues. It's possible that someone has already reported it. ## Logging This library uses Python's built-in `logging` module to perform logging of error, warning, informational and debug messages. The components within the SDK Core library use a single logger named `ibm-cloud-sdk-core`. For complete information on the logging facility, please see: [Logging facility for Python](https://docs.python.org/3/library/logging.html). ### Enable logging There are various ways to configure and enable the logging facility. The code example below demonstrates a simple way to enable debug logging by invoking the `logging.basicConfig()` function. Note that, as a convenience, if you set the logging level to `DEBUG`, then HTTP request/response message logging is also enabled. The following code example shows how debug logging can be enabled: ```python import logging # Create a basic logging configuration that: # 1. Defines a handler to display messages on the console. # 2. Sets the root logger's logging level to DEBUG. # 3. Sets the 'format' string used to display messages. logging.basicConfig(level=logging.DEBUG, format='%(asctime)s [%(name)s:%(levelname)s] %(message)s', force=True) ``` When running your application, you should see output like this if debug logging is enabled: ``` 2024-09-16 15:44:45,174 [ibm-cloud-sdk-core:DEBUG] Get authenticator from environment, key=global_search 2024-09-16 15:44:45,175 [ibm-cloud-sdk-core:DEBUG] Set service URL: https://api.global-search-tagging.cloud.ibm.com 2024-09-16 15:44:45,175 [ibm-cloud-sdk-core:DEBUG] Set User-Agent: ibm-python-sdk-core-3.24.4 os.name=Linux os.version=6.10.9-100.fc39.x86_64 python.version=3.12.5 2024-09-16 15:44:45,181 [ibm-cloud-sdk-core:DEBUG] Configuring BaseService instance with service name: global_search 2024-09-16 15:44:45,181 [ibm-cloud-sdk-core:DEBUG] Performing synchronous token fetch 2024-09-16 15:44:45,182 [ibm-cloud-sdk-core:DEBUG] Invoking IAM get_token operation: https://iam.cloud.ibm.com/identity/token 2024-09-16 15:44:45,182 [urllib3.connectionpool:DEBUG] Starting new HTTPS connection (1): iam.cloud.ibm.com:443 send: b'POST /identity/token HTTP/1.1\r\nHost: iam.cloud.ibm.com\r\nUser-Agent: ibm-python-sdk-core/iam-authenticator-3.24.4 os.name=Linux os.version=6.10.9-100.fc39.x86_64 python.version=3.12.5\r\nAccept-Encoding: gzip, deflate\r\nAccept: application/json\r\nConnection: keep-alive\r\nContent-Type: application/x-www-form-urlencoded\r\nContent-Length: 135\r\n\r\n' send: b'grant_type=urn%3Aibm%3Aparams%3Aoauth%3Agrant-type%3Aapikey&apikey=[redacted]&response_type=cloud_iam' reply: 'HTTP/1.1 200 OK\r\n' header: Content-Type: application/json header: Content-Language: en-US header: Content-Encoding: gzip header: Date: Mon, 16 Sep 2024 20:44:45 GMT header: Content-Length: 983 header: Connection: keep-alive 2024-09-16 15:44:45,670 [urllib3.connectionpool:DEBUG] https://iam.cloud.ibm.com:443 "POST /identity/token HTTP/11" 200 983 2024-09-16 15:44:45,672 [ibm-cloud-sdk-core:DEBUG] Returned from IAM get_token operation 2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Authenticated outbound request (type=iam) 2024-09-16 15:44:45,673 [ibm-cloud-sdk