Name: ibm-cos-sdk-python
Owner: International Business Machines
Description: ibm-cos-sdk-python
Created: 2017-09-09 13:12:14.0
Updated: 2018-05-02 22:47:14.0
Pushed: 2018-05-01 16:06:20.0
Homepage: null
Size: 3997
Language: Python
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This package allows Python developers to write software that interacts with IBM Cloud Object Storage. It is a fork of the boto3 library and 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.
For release notes, see the CHANGELOG.
You'll need:
Writer permissions.These values can be found in the Bluemix UI by generating a 'service credential'.
From Release 2.1.0 you can source credentials directly from a Service Credential JSON document generated in the IBM Cloud console saved to ~/.bluemix/cos_credentials. The SDK will automatically load these providing you have not explicitly set other credentials during client creation. If the Service Credential contain HMAC keys the client will use those and authenticate using a signature, otherwise the client will use the provided API key to authenticate using bearer tokens.
Install the library from PyPi using pip:
p install ibm-cos-sdk
Deprecation Notice for IBM Cloud Object Storage Java and Python SDK Versions 1.x
As of March 31, 2018, IBM will no longer add new features to the IBM Cloud Object Storage Java SDK Versions 1.x and the IBM Cloud Object Storage Python SDK Versions 1.x. We will continue to provide critical bug fixes to the 1.x releases through May 31, 2018.
Versions 1.x for Java and Python SDK will no longer be supported after May 31, 2018.
If you are using the 1.x version of the Java or Python SDK, please upgrade to the latest IBM Cloud Object Storage SDK versions 2.x. Instructions on how to upgrade from SDK Java and Python 1.x can be found in the “Migrating from 1.x.x” section of corresponding Readme.
Note: The IBM Cloud Object Storage Node.js SDK is NOT affected by this change.
For questions, please open an issue:
The 2.0 release of the SDK introduces a namespacing change that allows an application to make use of the original boto3 library to connect to AWS resources within the same application or environment. To migrate from 1.x to 2.0 some changes are necessary.
requirements.txt, or from PyPI via pip install -U ibm-cos-sdk. Verify no older versions exist with pip list | grep ibm-cos.boto3 to ibm_boto3.boto3 by updating the requirements.txt, or from PyPI via pip install boto3.Create a file BucketList.py, replacing your own values for API key, instance ID, and bucket name:
rt ibm_boto3
ibm_botocore.client import Config
key = 'API_KEY'
ice_instance_id = 'RESOURCE_INSTANCE_ID'
_endpoint = 'https://iam.bluemix.net/oidc/token'
ice_endpoint = 'https://s3-api.us-geo.objectstorage.softlayer.net'
bucket = 'NewBucket'
cold_bucket = 'NewColdBucket'
= ibm_boto3.resource('s3',
ibm_api_key_id=api_key,
ibm_service_instance_id=service_instance_id,
ibm_auth_endpoint=auth_endpoint,
config=Config(signature_version='oauth'),
endpoint_url=service_endpoint)
create_bucket(Bucket=new_bucket)
create_bucket(Bucket=new_cold_bucket,
CreateBucketConfiguration={
'LocationConstraint': 'us-cold'
},
bucket in cos.buckets.all():
print(bucket.name)
From the command line, run python BucketList.py. You should see a list of your buckets.
Assuming that you have Python and virtualenv installed, set up your
environment and install the required dependencies like this instead of
the pip install ibm-cos-sdk defined above:
t clone https://github.com/ibm/ibm-cos-sdk-python.git
ibm-cos-sdk-python
rtualenv venv
venv/bin/activate
p install -r requirements.txt
p install -e .
Feel free to use GitHub issues for tracking bugs and feature requests, but for help please use one of the following resources:
ibm and object-storage.This SDK is distributed under the Apache License, Version 2.0, see LICENSE.txt and NOTICE.txt for more information.