The official QingStor SDK for the Python programming language.
Project description
# 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).
<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).
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
qingstor-sdk-2.0.0.tar.gz
(12.6 kB
view hashes)
Built Distribution
Close
Hashes for qingstor_sdk-2.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 769846470a1e0d8acfde4b8ed9b22865a5478a63ad8aefeb3cce923449a4fb20 |
|
MD5 | 845fbd9359c6a482dcc22d0e9edd833b |
|
BLAKE2b-256 | 368c4d812794e7517b6361042d9f975dca003219a514cf790207b71bbfdc1b96 |