IBM Cloud Schematics Python SDK

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.

Table of Contents

• IBM Cloud Schematics Python SDK
  • Table of Contents
  • Overview
  • Prerequisites
  • Installation
  • Authentication
    • Authenticate with environment variables
    • Authenticate with external configuration
    • Authenticate programmatically
  • Getting Started
  • Error handling
  • Using the SDK
  • Questions
  • Issues
  • Open source @ IBM
  • Contributing
  • License

Overview

The IBM Cloud Schematics Python SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name	Imported Class Name
Schematics	schematicsv1

Prerequisites

• 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.

Installation

To install, use pip or easy_install:

pip install --upgrade "ibm-schematics>=1.1.0"

or

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
2. The programmatic approach
3. With an external credentials file

Authenticate with environment variables

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>

Authenticate with external configuration

To use an external configuration file, see the related documentation in the Python SDK Core document about authentication.

Authenticate programmatically

To learn more about how to use programmatic authentication, see the related documentation in the Python SDK Core document about authentication.

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.

Using the SDK

For general SDK usage information, please see this link

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question Stack Overflow.

Issues

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.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.md.

License

This SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.