Python client library to interact with various IBM Cloud Schematics APIs.
Disclaimer: this SDK is being released initially as a pre-release version. Changes might occur which impact applications that use this SDK.
The IBM Cloud Schematics Python SDK allows developers to programmatically interact with the following IBM Cloud services:
| Service Name | Imported Class Name |
|---|---|
| Schematics | schematicsv1 |
- An IBM Cloud account.
- An IAM API key to allow the SDK to access your account. Create one here.
- Python 3.5.3 or above.
To install, use pip or easy_install:
pip install --upgrade "ibm-schematics>=1.3.0"or
easy_install --upgrade "ibm-schematics>=1.3.0"The library requires Identity and Access Management (IAM) to authenticate requests. There are several ways to set the properties for authentication
For Schematics IAM authentication set the following environmental variables by replacing with your proper service credentials.
SCHEMATICS_URL = https://schematics.cloud.ibm.com
SCHEMATICS_APIKEY = <apikey>
To use an external configuration file, see the related documentation in the Python SDK Core document about authentication.
To learn more about how to use programmatic authentication, see the related documentation in the Python SDK Core document about authentication.
A quick example to get you up and running with Schematics Python SDK service
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
from ibm_schematics.schematics_v1 import SchematicsV1
authenticator = IAMAuthenticator('<apiKey>')
schematics_service = SchematicsV1(authenticator = authenticator)
schematics_service.set_service_url('https://schematics.cloud.ibm.com')
get_schematics_version_response = schematics_service.get_schematics_version()
version_response = get_schematics_version_response.get_result()
print(version_response)
For sample code on handling errors, please see Schematics API docs.
For general SDK usage information, please see this link
If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question Stack Overflow.
If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.
Find more open source projects on the IBM Github Page
See CONTRIBUTING.md.
This SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.