[](https://coveralls.io/github/yanheven/ali-opensearch-sdk?branch=master)
[](https://badge.fury.io/py/ali-opensearch)
### Aliyun OpenSearch Python SDK
ali-opensearch-sdk is a python SDK for [Aliyun OpenSearch](http://www.aliyun.com/product/opensearch) Product.
Based on OpenSearch API version v2. This SDK supports both python2.x and python3.x.
Pypi link:[https://pypi.python.org/pypi/ucloudclient](https://pypi.python.org/pypi/ali-opensearch/2.0.0)
Project manage [Launchpad](https://launchpad.net/ali-opensearch-python-sdk)
#### 1 Design
##### 1.1 SDK structure
There are 7 type of resources provided by opensearch, they are:
1, app: Application
2, data: Data Process
3, search: Search Related Action
4, suggest: Suggestion for Search
5, index: Index Reconstruction
6, quota: Quota Management
7, log: Error Log Query
There are 5 Operation for almost all resources, they are CURD as follow:
1, list: list all of this type of resources.
2, show: show detail information of a specific resource.
3,4,5, CUD: create, update and delete a specific resource.
###### 1.1.1 app Operation:
#### 2, Installation:
You can install via pip:
#pip install ali-opensearch
Or, From Source code:
#git clone https://git.oschina.net/yanhyphen/ali-opensearch-sdk.git
#cd ali-opensearch-sdk
#python setup.py install
#### 3, Getting Started :
from opensearchsdk.client import Client as osclient
client = osclient(base_url, key, key_id)
apps = client.app.list()
print apps
output:
{
u'status': u'OK',
u'total': u'1',
u'result': [
{
u'description': u'test',
u'created': u'1447753400',
u'id': u'119631',
u'name': u'test'
}
],
u'request_id': u'1447866418002866600607068'
}
More examples can be found in `opensearchsdk/demo.py`.
Note: All return data from server were remained.
#### 4, Contribute and BUG:
This project was managed via [Launchpad](https://launchpad.net/ali-opensearch-python-sdk).
Welcome to log bugs and commit patch.
Code style follow the PEP8 rules.
#### 5, License:
Apache License Version 2.0
#### 6, Release Note:
1, V2.0.0-dev Provide only few functions of opensearch, not yet cover all functions.
2, V2.0.0 completed all api functions.
3, V2.0.1 add compatibility for python3.5.
Metadata
Release files for ali-opensearch 2.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ali-opensearch-2.0.4.tar.gz | 11.6 kB | Without provenance | Details for ali-opensearch-2.0.4.tar.gz |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ali_opensearch-2.0.4-py3.5.egg | Legacy Egg format | - | - | Details for ali_opensearch-2.0.4-py3.5.egg |
| ali_opensearch-2.0.4-py2.7.egg | Legacy Egg format | - | - | Details for ali_opensearch-2.0.4-py2.7.egg |
Total release size: 98.3 kB
Release files / ali-opensearch-2.0.4.tar.gz
| Download URL | ali-opensearch-2.0.4.tar.gz |
|---|---|
| Size | 11.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6f84fe98e3114b5046d5a8c58bfc9f4aca96adadd92dfd94fa211111b1d8c03c
|
|
BLAKE2b-256 checksum How to use checksums |
a9afa2190d40ad3f314ac80141f72498f5882b5e9d89b00a1bdac218c822cee2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / ali_opensearch-2.0.4-py3.5.egg
| Download URL | ali_opensearch-2.0.4-py3.5.egg |
|---|---|
| Size | 44.3 kB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
1e6747c55419671049c811740e5b486ae5952e49b02124fc6efaa65c9ec7ca36
|
|
BLAKE2b-256 checksum How to use checksums |
70af086ff5182f2f1d70477b8c7d950326e58704c429ca6c6af7b6d96f8e2b80
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / ali_opensearch-2.0.4-py2.7.egg
| Download URL | ali_opensearch-2.0.4-py2.7.egg |
|---|---|
| Size | 42.3 kB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
b9bbc1a95db9ee32c3492b7bf8a24475d472a7c26f4fb68a136762cc2ad37afb
|
|
BLAKE2b-256 checksum How to use checksums |
71de55e324e187e6f1a56f2f935fa816f2f44672c5e17fb2ce3dc1feba6c9878
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for ali-opensearch 2.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.