Package: ibm-cos-sdk
IBM Cloud Object Storage - Python SDKThis package allows Python developers to write software that interacts withIBM Cloud Object Storage. It is a fork of theboto3libraryand can stand as a drop-in replacement if the application needs to connect to object storage using an S3-like API and does not make use of other AWS services.NoticeIBM has added aLanguage Support Policy. Language versions will be deprecated on the published schedule without additional notice.DocumentationCore documentation for IBM COSPython API reference documentationREST API reference documentationFor release notes, see theCHANGELOG.Building from SourceGetting HelpQuick startYou'll need:An instance of COS.An API key fromIBM Cloud Identity and Access Managementwith at leastWriterpermissions.The ID of the instance of COS that you are working with.Token acquisition endpoint.Service endpoint.These values can be found in the IBM Cloud Console bygenerating a 'service credential'.Using PythonUse of the Python SDK and example code can be foundhere.Using a Service CredentialAfter generating a Service Credential, the resulting JSON document can be saved to~/.bluemix/cos_credentials. The SDK will automatically source credentials from this file unless other credentials are explicitly set during client creation. If the cos_credentials file contains HMAC keys the client authenticates with a signature, otherwise the client uses the provided API key to authenticate by using a bearer token (using an API key still requires theconfig=Config(signature_version="oauth")to be included during client creation).Archive Tier SupportYou can automatically archive objects after a specified length of time or after a specified date. Once archived, a temporary copy of an object can be restored for access as needed. Restore time may take up to 15 hours.An archive policy is set at the bucket level by calling theput_bucket_lifecycle_configurationmethod on a client instance. A newly added or modified archive policy applies to new objects uploaded and does not affect existing objects. For more detail,see the documentation.Immutable Object StorageUsers can configure buckets with an Immutable Object Storage policy to prevent objects from being modified or deleted for a defined period of time. The retention period can be specified on a per-object basis, or objects can inherit a default retention period set on the bucket. It is also possible to set open-ended and permanent retention periods. Immutable Object Storage meets the rules set forth by the SEC governing record retention, and IBM Cloud administrators are unable to bypass these restrictions. For more detail,see the IBM Cloud documentation.Note: Immutable Object Storage does not support Aspera transfers via the SDK to upload objects or directories at this stage.Accelerated ArchiveUsers can set an archive rule that would allow data restore from an archive in 2 hours or 12 hours.LEGACY: Aspera high-speed transferAspera high-speed transfer through the COS SDK using thecos-asperalibrary is now legacy. New users and applications should use theAspera Transfer SDKinstead. Existing users should begin new projects with the Aspera Transfer SDK and make plans to migrate existing applications. Users who use S3 for transfers and do not installcos-asperaare unaffected.Building from sourceAssuming that you have Python andvirtualenvinstalled, set up your environment and install the required dependencies like this instead of thepip install ibm-cos-sdkdefined above:gitclonehttps://github.com/ibm/ibm-cos-sdk-python.gitcdibm-cos-sdk-python
$virtualenvvenv
...
.venv/bin/activate
pipinstall-rrequirements.txt
pipinstall-e.Getting HelpFeel free to use GitHub issues for tracking bugs and feature requests, but for help please use one of the following resources:Read a quick start guide inIBM Cloud Docs.Ask a question onStack Overflowand tag it withibmandobject-storage.Open a support ticket withIBM Cloud SupportIf it turns out that you may have found a bug, pleaseopen an issue.Language Support PolicyIBM supportscurrent public releases. IBM will deprecate language versions 90 days after a version reaches end-of-life. All clients will need to upgrade to a supported version before the end of the grace period.LicenseThis SDK is distributed under theApache License, Version 2.0, see LICENSE.txt and NOTICE.txt for more information.