qingstor-sdk


Nameqingstor-sdk JSON
Version 2.1.1 PyPI version JSON
download
home_pagehttps://github.com/yunify/qingstor-sdk-python
SummaryThe official QingStor SDK for the Python programming language.
upload_time2017-02-28 09:56:07
maintainer
docs_urlNone
authorYunify SDK Group
requires_python
licenseApache License 2.0
keywords
VCS
bugtrack_url
requirements PyYAML requests
Travis-CI
Coveralis test coverage No Coveralis.
            # QingStor SDK for Python

<span style="display: inline-block">
[![Build Status](https://travis-ci.org/yunify/qingstor-sdk-python.svg?branch=master)]
(https://travis-ci.org/yunify/qingstor-sdk-python)
[![API Reference](http://img.shields.io/badge/api-reference-green.svg)]
(http://docs.qingcloud.com/qingstor/)
[![License](http://img.shields.io/badge/license-apache%20v2-blue.svg)]
(https://github.com/yunify/qingstor-sdk-python/blob/master/LICENSE)
</span>

The official QingStor SDK for the Python programming language.

## Getting Started

### Installation

Refer to the [Installation Guide](docs/installation.md), and have this SDK installed.

### Preparation

Before your start, please python to [QingCloud Console](https://console.qingcloud.com/access_keys/) to create a pair of QingCloud API AccessKey.

___API AccessKey Example:___

``` yaml
access_key_id: 'ACCESS_KEY_ID_EXAMPLE'
secret_access_key: 'SECRET_ACCESS_KEY_EXAMPLE'
```

### Usage

Now you are ready to code. You can read the detailed guides in the list below to have a clear understanding or just take the quick start code example.

Checkout our [releases](https://github.com/yunify/qingstor-sdk-python/releases) and [change log](https://github.com/yunify/qingstor-sdk-python/blob/master/CHANGELOG.md) for information about the latest features, bug fixes and new ideas.

- [Configuration Guide](docs/configuration.md)
- [QingStor Service Usage Guide](docs/qingstor_service_usage.md)

___Quick Start Code Example:___

``` python
from qingstor.sdk.service.qingstor import QingStor
from qingstor.sdk.config import Config

config = Config('ACCESS_KEY_ID_EXAMPLE', 'SECRET_ACCESS_KEY_EXAMPLE')
qingstor = QingStor(config)

# List all buckets.
output = qingstor.list_buckets()

# Print HTTP status code.
print(output.status_code)

# Print the count of buckets.
print(output['count'])

# Print the first bucket name.
print(output['buckets'][0]['name'])

# Print Content-Type header.
print(output.headers['Content-Type'])

# Print whole content.
print(output.content)
```

## Reference Documentations

- [QingStor Documentation](https://docs.qingcloud.com/qingstor/index.html)
- [QingStor Guide](https://docs.qingcloud.com/qingstor/guide/index.html)
- [QingStor APIs](https://docs.qingcloud.com/qingstor/api/index.html)

## Contributing

1. Fork it ( https://github.com/yunify/qingstor-sdk-python/fork )
2. Create your feature branch (`git checkout -b new-feature`)
3. Commit your changes (`git commit -asm 'Add some feature'`)
4. Push to the branch (`git push origin new-feature`)
5. Create a new Pull Request

## LICENSE

The Apache License (Version 2.0, January 2004).



            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "coveralis": false, 
    "keywords": "", 
    "tox": true, 
    "requirements": [
        {
            "name": "PyYAML", 
            "specs": [
                [
                    "==", 
                    "3.12"
                ]
            ]
        }, 
        {
            "name": "requests", 
            "specs": [
                [
                    "==", 
                    "2.12.4"
                ]
            ]
        }
    ], 
    "author": "Yunify SDK Group", 
    "home_page": "https://github.com/yunify/qingstor-sdk-python", 
    "github_user": "yunify", 
    "download_url": "https://pypi.python.org/packages/f9/f1/f7afb8605bb3676d71fd1827fcaaa59f0ff6feeaf5e48593f7894cb2bac1/qingstor-sdk-2.1.1.tar.gz", 
    "platform": "", 
    "version": "2.1.1", 
    "cheesecake_documentation_id": null, 
    "description": "# QingStor SDK for Python\n\n<span style=\"display: inline-block\">\n[![Build Status](https://travis-ci.org/yunify/qingstor-sdk-python.svg?branch=master)]\n(https://travis-ci.org/yunify/qingstor-sdk-python)\n[![API Reference](http://img.shields.io/badge/api-reference-green.svg)]\n(http://docs.qingcloud.com/qingstor/)\n[![License](http://img.shields.io/badge/license-apache%20v2-blue.svg)]\n(https://github.com/yunify/qingstor-sdk-python/blob/master/LICENSE)\n</span>\n\nThe official QingStor SDK for the Python programming language.\n\n## Getting Started\n\n### Installation\n\nRefer to the [Installation Guide](docs/installation.md), and have this SDK installed.\n\n### Preparation\n\nBefore your start, please python to [QingCloud Console](https://console.qingcloud.com/access_keys/) to create a pair of QingCloud API AccessKey.\n\n___API AccessKey Example:___\n\n``` yaml\naccess_key_id: 'ACCESS_KEY_ID_EXAMPLE'\nsecret_access_key: 'SECRET_ACCESS_KEY_EXAMPLE'\n```\n\n### Usage\n\nNow you are ready to code. You can read the detailed guides in the list below to have a clear understanding or just take the quick start code example.\n\nCheckout our [releases](https://github.com/yunify/qingstor-sdk-python/releases) and [change log](https://github.com/yunify/qingstor-sdk-python/blob/master/CHANGELOG.md) for information about the latest features, bug fixes and new ideas.\n\n- [Configuration Guide](docs/configuration.md)\n- [QingStor Service Usage Guide](docs/qingstor_service_usage.md)\n\n___Quick Start Code Example:___\n\n``` python\nfrom qingstor.sdk.service.qingstor import QingStor\nfrom qingstor.sdk.config import Config\n\nconfig = Config('ACCESS_KEY_ID_EXAMPLE', 'SECRET_ACCESS_KEY_EXAMPLE')\nqingstor = QingStor(config)\n\n# List all buckets.\noutput = qingstor.list_buckets()\n\n# Print HTTP status code.\nprint(output.status_code)\n\n# Print the count of buckets.\nprint(output['count'])\n\n# Print the first bucket name.\nprint(output['buckets'][0]['name'])\n\n# Print Content-Type header.\nprint(output.headers['Content-Type'])\n\n# Print whole content.\nprint(output.content)\n```\n\n## Reference Documentations\n\n- [QingStor Documentation](https://docs.qingcloud.com/qingstor/index.html)\n- [QingStor Guide](https://docs.qingcloud.com/qingstor/guide/index.html)\n- [QingStor APIs](https://docs.qingcloud.com/qingstor/api/index.html)\n\n## Contributing\n\n1. Fork it ( https://github.com/yunify/qingstor-sdk-python/fork )\n2. Create your feature branch (`git checkout -b new-feature`)\n3. Commit your changes (`git commit -asm 'Add some feature'`)\n4. Push to the branch (`git push origin new-feature`)\n5. Create a new Pull Request\n\n## LICENSE\n\nThe Apache License (Version 2.0, January 2004).\n\n\n", 
    "upload_time": "2017-02-28 09:56:07", 
    "lcname": "qingstor-sdk", 
    "bugtrack_url": null, 
    "github": true, 
    "name": "qingstor-sdk", 
    "license": "Apache License 2.0", 
    "travis_ci": true, 
    "github_project": "qingstor-sdk-python", 
    "summary": "The official QingStor SDK for the Python programming language.", 
    "split_keywords": [], 
    "author_email": "sdk_group@yunify.com", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2017-02-28T09:56:07", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/f9/f1/f7afb8605bb3676d71fd1827fcaaa59f0ff6feeaf5e48593f7894cb2bac1/qingstor-sdk-2.1.1.tar.gz", 
            "md5_digest": "4a7357556242b4d8d746d72d1023379c", 
            "downloads": 0, 
            "filename": "qingstor-sdk-2.1.1.tar.gz", 
            "packagetype": "sdist", 
            "path": "f9/f1/f7afb8605bb3676d71fd1827fcaaa59f0ff6feeaf5e48593f7894cb2bac1/qingstor-sdk-2.1.1.tar.gz", 
            "size": 18747
        }, 
        {
            "has_sig": false, 
            "upload_time": "2017-02-28T09:56:04", 
            "comment_text": "", 
            "python_version": "py2.py3", 
            "url": "https://pypi.python.org/packages/46/9f/00de4a92390fbdc66e0d324f84c0dbbbfcd93c298032c967bb3c279775f5/qingstor_sdk-2.1.1-py2.py3-none-any.whl", 
            "md5_digest": "52158fa3b045a4fe32604dd7f5a189b8", 
            "downloads": 0, 
            "filename": "qingstor_sdk-2.1.1-py2.py3-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "46/9f/00de4a92390fbdc66e0d324f84c0dbbbfcd93c298032c967bb3c279775f5/qingstor_sdk-2.1.1-py2.py3-none-any.whl", 
            "size": 23445
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}