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

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 Billing Units partner_billing_units_v1 PartnerBillingUnitsV1
Partner Usage Reports partner_usage_reports_v1 PartnerUsageReportsV1
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.

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.57.0.tar.gz (326.3 kB view details)

Uploaded Source

Built Distribution

ibm_platform_services-0.57.0-py3-none-any.whl (343.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for ibm_platform_services-0.57.0.tar.gz
Algorithm Hash digest
SHA256 710b6bd280b6f9374cce7e4251367f28ab113160ca41199ee6fa0992c1cc9072
MD5 926320fda1312c729f5b36fad49ca418
BLAKE2b-256 c0003bc6f9a95c2df4ea6a55b8555b1e1e9eee7c57c17fb73e5dc5c5e456f123

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ibm_platform_services-0.57.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4c8f18ad0f4884e355f29e6f62641f21bb4c2b78e678771c6eb92731ddeabb29
MD5 93a903f00d5c2fd44c35952557dcbe47
BLAKE2b-256 1ade133ec8226c4feae658ecf6cb029684176b566c8b19c439a899888d8ba776

See more details on using hashes here.

Supported by

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