Project: ibm-platform-services

Python client library for IBM Cloud Platform Services

Project Details

Latest version
0.48.1
Home Page
https://github.com/IBM/platform-services-python-sdk
PyPI Page
https://pypi.org/project/ibm-platform-services/

Project Popularity

PageRank
0.001617859703825796
Number of downloads
78757

Build Status Release PyPI - Python Version PyPI PyPI - Downloads License semantic-release CLA assistant

IBM Cloud Platform Services Python SDK Version 0.48.1

Python client library to interact with various IBM Cloud Platform Service APIs.

Table of Contents

Overview

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

Service Name Module Name Service Class Name
Case Management case_management_v1 CaseManagementV1
Catalog Management catalog_management_v1 CatalogManagementV1
Context Based Restrictions context_based_restrictions_v1 ContextBasedRestrictionsV1
Enterprise Billing Units enterprise_billing_units_v1 EnterpriseBillingUnitsV1
Enterprise Management enterprise_management_v1 EnterpriseManagementV1
Enterprise Usage Reports enterprise_usage_reports_v1 EnterpriseUsageReportsV1
Global Catalog global_catalog_v1 GlobalCatalogV1
Global Search global_search_v2 GlobalSearchV2
Global Tagging global_tagging_v1 GlobalTaggingV1
IAM Access Groups iam_access_groups_v2 IamAccessGroupsV2
IAM Identity Service iam_identity_v1 IamIdentityV1
IAM Policy Management iam_policy_management_v1 IamPolicyManagementV1
IBM Cloud Shell ibm_cloud_shell_v1 IbmCloudShellV1
Open Service Broker open_service_broker_v1 OpenServiceBrokerV1
Resource Controller resource_controller_v2 ResourceControllerV2
Resource Manager resource_manager_v2 ResourceManagerV2
Usage Metering usage_metering_v4 UsageMeteringV4
Usage Reports usage_reports_v4 UsageReportsV4
User Management user_management_v1 UserManagementV1

The following services have been relocated to a different SDK project. Please consult the documentation for each service to determine the new location:

Service Name Module Name Service Class Name
Configuration Governance configuration_governance_v1 ConfigurationGovernanceV1
Posture Management posture_management_v1 PostureManagementV1

Prerequisites

  • An IBM Cloud account.
  • An IAM API key to allow the SDK to access your account. Create one here.
  • Python 3.8 or above.

Installation

To install, use pip:

python -m pip install --upgrade ibm-platform-services

Then in your code, you can import the appropriate service like this:

from ibm_platform_services.<service-module-name> import *

where <service-module-name> is the service's module name from the table above

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