proxy_oss2


Nameproxy_oss2 JSON
Version 2.3.2 PyPI version JSON
download
home_pagehttps://github.com/Yinzhe-Qi/aliyun-oss-python-sdk
SummaryAliyun OSS (Object Storage Service) SDK With Proxies Support
upload_time
maintainer
docs_urlNone
authorYinzhe_Qi
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage
            Alibaba Cloud OSS SDK for Python
==========================

.. image:: https://badge.fury.io/py/oss2.svg
    :target: https://badge.fury.io/py/oss2
.. image:: https://travis-ci.org/aliyun/aliyun-oss-python-sdk.svg?branch=master
    :target: https://travis-ci.org/aliyun/aliyun-oss-python-sdk
.. image:: https://coveralls.io/repos/github/aliyun/aliyun-oss-python-sdk/badge.svg?branch=master
    :target: https://coveralls.io/github/aliyun/aliyun-oss-python-sdk?branch=master

`README of Chinese <https://github.com/aliyun/aliyun-oss-python-sdk/blob/master/README-CN.rst>`_    
------------------
    
Overview
----

Alibaba Cloud Object Storage Python SDK 2.x. This version is not compatible with the previous version (Version 0.x). The package name is `oss2` to avoid conflict with previous versions. 


The SDK of this version is dependent on the third-party HTTP library `requests <https://github.com/kennethreitz/requests>`_ and `crcmod`. Install the SDK following the methods below. 

Note:

    This version does not contain the `osscmd` command line tool. 

Run environment
--------

Python 2.6,2.7,3.3,3.4,3.5

.. note::

    Do not use Python 3.3.0 or 3.3.1. Refer to `Python Issue 16658 <https://bugs.python.org/issue16658>`_.

Installation method
--------

Install the official release version through PIP (taking Linux as an example): 

.. code-block:: bash

    $ pip install oss2

You can also install the unzipped installer package directly: 

.. code-block:: bash

    $ sudo python setup.py install


Quick use
--------

.. code-block:: python

    # -*- coding: utf-8 -*-

    import oss2

    endpoint = 'http://oss-cn-hangzhou.aliyuncs.com' # Suppose that your bucket is in the Hangzhou region. 

    auth = oss2.Auth('<Your AccessKeyID>', '<Your AccessKeySecret>')
    bucket = oss2.Bucket(auth, endpoint, '<your bucket name>')

    # The object key in the bucket is story.txt
    key = 'story.txt'

    # Upload
    bucket.put_object(key, 'Ali Baba is a happy youth.')

    # Download
    bucket.get_object(key).read()

    # Delete
    bucket.delete_object(key)

    # Traverse all objects in the bucket
    for object_info in oss2.ObjectIterator(bucket):
        print(object_info.key)

For more examples, refer to the code under the "examples" directory. 

Handle errors
--------

The Python SDK interface will throw an exception in case of an error (see oss2.exceptions sub-module) unless otherwise specified. An example is provided below:

.. code-block:: python

    try:
        result = bucket.get_object(key)
        print(result.read())
    except oss2.exceptions.NoSuchKey as e:
        print('{0} not found: http_status={1}, request_id={2}'.format(key, e.status, e.request_id))

Test
----

First set the required AccessKeyId, AccessKeySecret, endpoint and bucket information for the test through environment variables (**Do not use the bucket for the production environment**). 
Take the Linux system for example: 

.. code-block:: bash

    $ export OSS_TEST_ACCESS_KEY_ID=<AccessKeyId>
    $ export OSS_TEST_ACCESS_KEY_SECRET=<AccessKeySecret>
    $ export OSS_TEST_ENDPOINT=<endpoint>
    $ export OSS_TEST_BUCKET=<bucket>

    $ export OSS_TEST_STS_ID=<AccessKeyId for testing STS>
    $ export OSS_TEST_STS_KEY=<AccessKeySecret for testing STS>
    $ export OSS_TEST_STS_ARN=<Role ARN for testing STS>


Run the test in the following method: 

.. code-block:: bash

    $ nosetests                          # First install nose

More usage
--------
- `More examples can be found <https://github.com/aliyun/aliyun-oss-python-sdk/tree/master/examples>`_. 
- `Python SDK API documentation <http://aliyun-oss-python-sdk.readthedocs.org/en/latest>`_. 
- `Official Python SDK documentation <https://help.aliyun.com/document_detail/32026.html>`_.

Contact us
--------
- `Alibaba Cloud OSS official website <http://oss.aliyun.com>`_.
- `Alibaba Cloud OSS official forum <http://bbs.aliyun.com>`_.
- `Alibaba Cloud OSS official documentation center <https://help.aliyun.com/document_detail/32026.html>`_.
- Alibaba Cloud official technical support: `Submit a ticket <https://workorder.console.aliyun.com/#/ticket/createIndex>`_.

Code license
--------
For the MIT license, see LICENSE object. 

            

Raw data

            {
    "_id": null,
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "cheesecake_code_kwalitee_id": null,
    "keywords": "",
    "tox": true,
    "author": "Yinzhe_Qi",
    "home_page": "https://github.com/Yinzhe-Qi/aliyun-oss-python-sdk",
    "github_user": "Yinzhe-Qi",
    "download_url": "",
    "platform": "",
    "version": "2.3.2",
    "cheesecake_documentation_id": null,
    "description": "Alibaba Cloud OSS SDK for Python\r\n==========================\r\n\r\n.. image:: https://badge.fury.io/py/oss2.svg\r\n    :target: https://badge.fury.io/py/oss2\r\n.. image:: https://travis-ci.org/aliyun/aliyun-oss-python-sdk.svg?branch=master\r\n    :target: https://travis-ci.org/aliyun/aliyun-oss-python-sdk\r\n.. image:: https://coveralls.io/repos/github/aliyun/aliyun-oss-python-sdk/badge.svg?branch=master\r\n    :target: https://coveralls.io/github/aliyun/aliyun-oss-python-sdk?branch=master\r\n\r\n`README of Chinese <https://github.com/aliyun/aliyun-oss-python-sdk/blob/master/README-CN.rst>`_    \r\n------------------\r\n    \r\nOverview\r\n----\r\n\r\nAlibaba Cloud Object Storage Python SDK 2.x. This version is not compatible with the previous version (Version 0.x). The package name is `oss2` to avoid conflict with previous versions. \r\n\r\n\r\nThe SDK of this version is dependent on the third-party HTTP library `requests <https://github.com/kennethreitz/requests>`_ and `crcmod`. Install the SDK following the methods below. \r\n\r\nNote:\r\n\r\n    This version does not contain the `osscmd` command line tool. \r\n\r\nRun environment\r\n--------\r\n\r\nPython 2.6\uff0c2.7\uff0c3.3\uff0c3.4\uff0c3.5\r\n\r\n.. note::\r\n\r\n    Do not use Python 3.3.0 or 3.3.1. Refer to `Python Issue 16658 <https://bugs.python.org/issue16658>`_.\r\n\r\nInstallation method\r\n--------\r\n\r\nInstall the official release version through PIP (taking Linux as an example): \r\n\r\n.. code-block:: bash\r\n\r\n    $ pip install oss2\r\n\r\nYou can also install the unzipped installer package directly: \r\n\r\n.. code-block:: bash\r\n\r\n    $ sudo python setup.py install\r\n\r\n\r\nQuick use\r\n--------\r\n\r\n.. code-block:: python\r\n\r\n    # -*- coding: utf-8 -*-\r\n\r\n    import oss2\r\n\r\n    endpoint = 'http://oss-cn-hangzhou.aliyuncs.com' # Suppose that your bucket is in the Hangzhou region. \r\n\r\n    auth = oss2.Auth('<Your AccessKeyID>', '<Your AccessKeySecret>')\r\n    bucket = oss2.Bucket(auth, endpoint, '<your bucket name>')\r\n\r\n    # The object key in the bucket is story.txt\r\n    key = 'story.txt'\r\n\r\n    # Upload\r\n    bucket.put_object(key, 'Ali Baba is a happy youth.')\r\n\r\n    # Download\r\n    bucket.get_object(key).read()\r\n\r\n    # Delete\r\n    bucket.delete_object(key)\r\n\r\n    # Traverse all objects in the bucket\r\n    for object_info in oss2.ObjectIterator(bucket):\r\n        print(object_info.key)\r\n\r\nFor more examples, refer to the code under the \"examples\" directory. \r\n\r\nHandle errors\r\n--------\r\n\r\nThe Python SDK interface will throw an exception in case of an error (see oss2.exceptions sub-module) unless otherwise specified. An example is provided below:\r\n\r\n.. code-block:: python\r\n\r\n    try:\r\n        result = bucket.get_object(key)\r\n        print(result.read())\r\n    except oss2.exceptions.NoSuchKey as e:\r\n        print('{0} not found: http_status={1}, request_id={2}'.format(key, e.status, e.request_id))\r\n\r\nTest\r\n----\r\n\r\nFirst set the required AccessKeyId, AccessKeySecret, endpoint and bucket information for the test through environment variables (**Do not use the bucket for the production environment**). \r\nTake the Linux system for example: \r\n\r\n.. code-block:: bash\r\n\r\n    $ export OSS_TEST_ACCESS_KEY_ID=<AccessKeyId>\r\n    $ export OSS_TEST_ACCESS_KEY_SECRET=<AccessKeySecret>\r\n    $ export OSS_TEST_ENDPOINT=<endpoint>\r\n    $ export OSS_TEST_BUCKET=<bucket>\r\n\r\n    $ export OSS_TEST_STS_ID=<AccessKeyId for testing STS>\r\n    $ export OSS_TEST_STS_KEY=<AccessKeySecret for testing STS>\r\n    $ export OSS_TEST_STS_ARN=<Role ARN for testing STS>\r\n\r\n\r\nRun the test in the following method: \r\n\r\n.. code-block:: bash\r\n\r\n    $ nosetests                          # First install nose\r\n\r\nMore usage\r\n--------\r\n- `More examples can be found <https://github.com/aliyun/aliyun-oss-python-sdk/tree/master/examples>`_. \r\n- `Python SDK API documentation <http://aliyun-oss-python-sdk.readthedocs.org/en/latest>`_. \r\n- `Official Python SDK documentation <https://help.aliyun.com/document_detail/32026.html>`_.\r\n\r\nContact us\r\n--------\r\n- `Alibaba Cloud OSS official website <http://oss.aliyun.com>`_.\r\n- `Alibaba Cloud OSS official forum <http://bbs.aliyun.com>`_.\r\n- `Alibaba Cloud OSS official documentation center <https://help.aliyun.com/document_detail/32026.html>`_.\r\n- Alibaba Cloud official technical support: `Submit a ticket <https://workorder.console.aliyun.com/#/ticket/createIndex>`_.\r\n\r\nCode license\r\n--------\r\nFor the MIT license, see LICENSE object. \r\n",
    "lcname": "proxy_oss2",
    "name": "proxy_oss2",
    "github": true,
    "bugtrack_url": null,
    "license": "",
    "travis_ci": true,
    "github_project": "aliyun-oss-python-sdk",
    "summary": "Aliyun OSS (Object Storage Service) SDK With Proxies Support",
    "split_keywords": [],
    "author_email": "",
    "urls": [],
    "cheesecake_installability_id": null,
    "coveralls": true
}
        
Elapsed time: 0.05241s