[](https://travis-ci.com/IBM/schematics-python-sdk)
[](https://github.com/semantic-release/semantic-release)
# IBM Cloud Schematics Python SDK
Python client library to interact with various [IBM Cloud Schematics APIs](https://cloud.ibm.com/apidocs?category=schematics).
Disclaimer: this SDK is being released initially as a **pre-release** version.
Changes might occur which impact applications that use this SDK.
## Table of Contents
<!--
The TOC below is generated using the `markdown-toc` node package.
https://github.com/jonschlinkert/markdown-toc
You should regenerate the TOC after making changes to this file.
npx markdown-toc -i README.md
-->
<!-- toc -->
- [IBM Cloud Schematics Python SDK](#ibm-cloud-schematics-python-sdk)
- [Table of Contents](#table-of-contents)
- [Overview](#overview)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Authentication](#authentication)
- [Authenticate with environment variables](#authenticate-with-environment-variables)
- [Authenticate with external configuration](#authenticate-with-external-configuration)
- [Authenticate programmatically](#authenticate-programmatically)
- [Getting Started](#getting-started)
- [Error handling](#error-handling)
- [Using the SDK](#using-the-sdk)
- [Questions](#questions)
- [Issues](#issues)
- [Open source @ IBM](#open-source--ibm)
- [Contributing](#contributing)
- [License](#license)
<!-- tocstop -->
## Overview
The IBM Cloud Schematics Python SDK allows developers to programmatically interact with the following
IBM Cloud services:
Service Name | Imported Class Name
--- | ---
[Schematics](https://cloud.ibm.com/apidocs/schematics) | schematicsv1
## Prerequisites
[ibm-cloud-onboarding]: https://cloud.ibm.com/registration
* An [IBM Cloud][ibm-cloud-onboarding] account.
* An IAM API key to allow the SDK to access your account. Create one [here](https://cloud.ibm.com/iam/apikeys).
* Python 3.5.3 or above.
## Installation
To install, use `pip` or `easy_install`:
```bash
pip install --upgrade "ibm-schematics>=1.1.0"
```
or
```bash
easy_install --upgrade "ibm-schematics>=1.1.0"
```
## Authentication
The library requires Identity and Access Management (IAM) to authenticate requests. There are several ways to set the properties for authentication
1. [As environment variables](#authenticate-with-environment-variables)
2. [The programmatic approach](#authenticate-programmatically)
3. [With an external credentials file](#authenticate-with-external-configuration)
### Authenticate with environment variables
For Schematics IAM authentication set the following environmental variables by replacing <apikey> with your proper service credentials.
```
SCHEMATICS_URL = https://schematics.cloud.ibm.com
SCHEMATICS_APIKEY = <apikey>
```
### Authenticate with external configuration
To use an external configuration file, see the related documentation in the [Python SDK Core document about authentication](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).
### Authenticate programmatically
To learn more about how to use programmatic authentication, see the related documentation in the [Python SDK Core document about authentication](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).
## Getting Started
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)
```
## Error handling
For sample code on handling errors, please see [Schematics API docs](https://cloud.ibm.com/apidocs/schematics#error-handling).
## Using the SDK
For general SDK usage information, please see [this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md)
## Questions
If you are having difficulties using this SDK or have a question about the IBM Cloud services,
please ask a question
[Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-cloud).
## Issues
If you encounter an issue with the project, you are welcome to submit a
[bug report](https://github.com/IBM/schematics-python-sdk.git/issues).
Before that, please search for similar issues. It's possible that someone has already reported the problem.
## Open source @ IBM
Find more open source projects on the [IBM Github Page](http://ibm.github.io/)
## Contributing
See [CONTRIBUTING.md](https://github.com/IBM/schematics-python-sdk.git/blob/master/CONTRIBUTING.md).
## License
This SDK is released under the Apache 2.0 license.
The license's full text can be found in [LICENSE](https://github.com/IBM/schematics-python-sdk.git/blob/master/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/IBM/schematics-python-sdk.git",
"name": "ibm-schematics",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ibm_schematics",
"author": "IBM",
"author_email": "nvenkatesh.27@gmail.com",
"download_url": "",
"platform": null,
"description": "[](https://travis-ci.com/IBM/schematics-python-sdk)\n[](https://github.com/semantic-release/semantic-release)\n# IBM Cloud Schematics Python SDK\n\nPython client library to interact with various [IBM Cloud Schematics APIs](https://cloud.ibm.com/apidocs?category=schematics).\n\nDisclaimer: this SDK is being released initially as a **pre-release** version.\nChanges might occur which impact applications that use this SDK.\n\n## Table of Contents\n\n<!--\n The TOC below is generated using the `markdown-toc` node package.\n\n https://github.com/jonschlinkert/markdown-toc\n\n You should regenerate the TOC after making changes to this file.\n\n npx markdown-toc -i README.md\n -->\n\n<!-- toc -->\n\n- [IBM Cloud Schematics Python SDK](#ibm-cloud-schematics-python-sdk)\n - [Table of Contents](#table-of-contents)\n - [Overview](#overview)\n - [Prerequisites](#prerequisites)\n - [Installation](#installation)\n - [Authentication](#authentication)\n - [Authenticate with environment variables](#authenticate-with-environment-variables)\n - [Authenticate with external configuration](#authenticate-with-external-configuration)\n - [Authenticate programmatically](#authenticate-programmatically)\n - [Getting Started](#getting-started)\n - [Error handling](#error-handling)\n - [Using the SDK](#using-the-sdk)\n - [Questions](#questions)\n - [Issues](#issues)\n - [Open source @ IBM](#open-source--ibm)\n - [Contributing](#contributing)\n - [License](#license)\n\n<!-- tocstop -->\n\n## Overview\n\nThe IBM Cloud Schematics Python SDK allows developers to programmatically interact with the following\nIBM Cloud services:\n\nService Name | Imported Class Name\n--- | ---\n[Schematics](https://cloud.ibm.com/apidocs/schematics) | schematicsv1 \n\n## Prerequisites\n\n[ibm-cloud-onboarding]: https://cloud.ibm.com/registration\n\n* An [IBM Cloud][ibm-cloud-onboarding] account.\n* An IAM API key to allow the SDK to access your account. Create one [here](https://cloud.ibm.com/iam/apikeys).\n* Python 3.5.3 or above.\n\n## Installation\n\nTo install, use `pip` or `easy_install`:\n\n```bash\npip install --upgrade \"ibm-schematics>=1.1.0\"\n```\n\nor\n\n```bash\neasy_install --upgrade \"ibm-schematics>=1.1.0\"\n```\n\n## Authentication\n\nThe library requires Identity and Access Management (IAM) to authenticate requests. There are several ways to set the properties for authentication\n\n1. [As environment variables](#authenticate-with-environment-variables)\n2. [The programmatic approach](#authenticate-programmatically)\n3. [With an external credentials file](#authenticate-with-external-configuration)\n\n### Authenticate with environment variables\n\nFor Schematics IAM authentication set the following environmental variables by replacing <apikey> with your proper service credentials.\n\n```\nSCHEMATICS_URL = https://schematics.cloud.ibm.com\nSCHEMATICS_APIKEY = <apikey>\n```\n\n### Authenticate with external configuration\n\nTo use an external configuration file, see the related documentation in the [Python SDK Core document about authentication](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).\n\n### Authenticate programmatically\n\nTo learn more about how to use programmatic authentication, see the related documentation in the [Python SDK Core document about authentication](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).\n\n## Getting Started\n\nA quick example to get you up and running with Schematics Python SDK service\n\n```\n\nfrom ibm_cloud_sdk_core.authenticators import IAMAuthenticator\nfrom ibm_schematics.schematics_v1 import SchematicsV1\n\nauthenticator = IAMAuthenticator('<apiKey>')\nschematics_service = SchematicsV1(authenticator = authenticator)\nschematics_service.set_service_url('https://schematics.cloud.ibm.com')\n\nget_schematics_version_response = schematics_service.get_schematics_version()\nversion_response = get_schematics_version_response.get_result()\nprint(version_response)\n\n\n```\n\n## Error handling\n\nFor sample code on handling errors, please see [Schematics API docs](https://cloud.ibm.com/apidocs/schematics#error-handling).\n\n## Using the SDK\nFor general SDK usage information, please see [this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md)\n\n## Questions\n\nIf you are having difficulties using this SDK or have a question about the IBM Cloud services,\nplease ask a question\n[Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-cloud).\n\n## Issues\nIf you encounter an issue with the project, you are welcome to submit a\n[bug report](https://github.com/IBM/schematics-python-sdk.git/issues).\nBefore that, please search for similar issues. It's possible that someone has already reported the problem.\n\n## Open source @ IBM\nFind more open source projects on the [IBM Github Page](http://ibm.github.io/)\n\n## Contributing\nSee [CONTRIBUTING.md](https://github.com/IBM/schematics-python-sdk.git/blob/master/CONTRIBUTING.md).\n\n## License\n\nThis SDK is released under the Apache 2.0 license.\nThe license's full text can be found in [LICENSE](https://github.com/IBM/schematics-python-sdk.git/blob/master/LICENSE).\n\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "IBM Cloud Schematics Python SDK",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/IBM/schematics-python-sdk.git"
},
"split_keywords": [
"ibm_schematics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eed06f58428e2c67deb07c1ec3f0641c094e25668dc1dd0beae809fdbda11a6d",
"md5": "4cbc2010953cc829bb3174b24c189eb6",
"sha256": "0e348f7c75edee03d49fbf217eceaa3ee7c77c98688aaa38c91329ec5b878977"
},
"downloads": -1,
"filename": "ibm_schematics-2.0.0-py2-none-any.whl",
"has_sig": false,
"md5_digest": "4cbc2010953cc829bb3174b24c189eb6",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 186339,
"upload_time": "2022-08-26T13:33:27",
"upload_time_iso_8601": "2022-08-26T13:33:27.851874Z",
"url": "https://files.pythonhosted.org/packages/ee/d0/6f58428e2c67deb07c1ec3f0641c094e25668dc1dd0beae809fdbda11a6d/ibm_schematics-2.0.0-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-08-26 13:33:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IBM",
"github_project": "schematics-python-sdk",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "ibm_cloud_sdk_core",
"specs": [
[
"<",
"4.0.0"
],
[
">=",
"3.19.2"
]
]
}
],
"lcname": "ibm-schematics"
}
JSON
