Skip to main content

Python client library for IBM Cloud Platform Services

Project description

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

IBM Cloud Platform Services Python SDK Version 0.66.2

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
Partner Management APIs partner_management_v1 PartnerManagementV1
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.9 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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ibm_platform_services-0.66.2.tar.gz (347.1 kB view details)

Uploaded Source

Built Distribution

ibm_platform_services-0.66.2-py3-none-any.whl (363.9 kB view details)

Uploaded Python 3

File details

Details for the file ibm_platform_services-0.66.2.tar.gz.

File metadata

  • Download URL: ibm_platform_services-0.66.2.tar.gz
  • Upload date:
  • Size: 347.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.4

File hashes

Hashes for ibm_platform_services-0.66.2.tar.gz
Algorithm Hash digest
SHA256 7e1bef0570f84d022c101d98ce6ddabf1968fc09116badc759e5f88f3b6e3ecf
MD5 4a9b528142ac94fbf44ff4442d98a12e
BLAKE2b-256 aea9090215b90b12aac0bee08b9236410e8336f61e1cd1f4bba18b00d9b742d4

See more details on using hashes here.

File details

Details for the file ibm_platform_services-0.66.2-py3-none-any.whl.

File metadata

File hashes

Hashes for ibm_platform_services-0.66.2-py3-none-any.whl
Algorithm Hash digest
SHA256 43010e7fe0380a3cd01c3cb276921c1a5a8a0b2855d321790fae0e3483fcee8e
MD5 2c507b4459e9319da8cea47af0b496d8
BLAKE2b-256 b7e9f8ead8cc5ad2b01a6c989330a876399061ba896a74f29ac79869b71a272c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page