Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deanthompson/pyelong
Python SDK for Elong OpenAPI.
https://github.com/deanthompson/pyelong
Last synced: about 2 months ago
JSON representation
Python SDK for Elong OpenAPI.
- Host: GitHub
- URL: https://github.com/deanthompson/pyelong
- Owner: DeanThompson
- License: mit
- Created: 2015-06-18T11:17:20.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-10-02T21:36:29.000Z (over 5 years ago)
- Last Synced: 2024-08-10T19:59:14.485Z (5 months ago)
- Language: Python
- Size: 48.8 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
pyelong
=======
[艺龙 API](http://open.elong.com/wiki/API%E6%96%87%E6%A1%A3) 的 Python 封装。
参考了 @icyleaf 的这个项目：[https://github.com/icyleaf/elong/](https://github.com/icyleaf/elong/)
## 特点
- 支持国内酒店(hotel)／国际酒店(ihotel)等所有 API
- 自动选择 HTTP／HTTPS
- 计算签名、生成请求链接
- 使用简单，调用参数与文档保持一致
- 支持同步（requests）和 Tornado 异步（AsyncHTTPClient, coroutine）
- 有信用卡加密方法
- requests 请求支持简单的基于 HTTP 状态码和 API 错误码的重试
- 支持使用代理
## 不支持
- 没有针对 API 做参数检查
- 不支持 xml 格式的请求和返回值
## 安装
用 pip 安装：
```bash
pip install pyelong
```
或者：
```bash
pip install -e git+https://github.com/DeanThompson/pyelong.git@master#egg=pyelong
```
也可以通过源码安装：
```bash
git clone [email protected]:DeanThompson/pyelong.git
cd pyelong
python setup.py install
```
依赖:
- [requests](http://docs.python-requests.org/en/latest/)
- [Tornado](http://www.tornadoweb.org/en/stable/)
- [pycrypto](https://www.dlitz.net/software/pycrypto/)
## 使用
假设已经在艺龙注册了 API 用户，得到了 `user`, `app_key`, `secret_key`，并且 IP 已经在艺龙的白名单里。
### 初始化一个客户端 `client`
```python
from pyelong import Client
client = Client(user=user, app_key=app_key, secret_key=secret_key)
# 初始化 client 时还可以传入：
#
# host: 指定 API 的 host，在开发时最好指定测试环境的 host
# local: 语言
# version: API 版本，默认 1.1
# use_tornado: 是否适配 Tornado
# cert: SSL 证书文件路径，如果不指定不会进行证书检查
```
### 调用
```python
response = client.hotel.list(ArrivalDate='06/24/2015', DepartureDate='06/25/2015', CityId='0101')
# HTTP 状态码
print response.status_code
# API 状态码
print response.code
# API 错误
print response.error
# API 返回结果，是一个 json 对象
print response.result
# print response
```
## 与 Tornado 一起使用
```python
from tornado.web import RequestHandler, Application
from tornado import gen, ioloop, options
from pyelong import Client
client = Client(
user=user,
app_key=app_key,
secret_key=secret_key,
host='api.test.lohoo.com/rest', # 测试环境
use_tornado=True # 显示设置为 True，使用 AsyncHTTPClient
)
class HotelListHandler(RequestHandler):
@gen.coroutine
def get():
resp = yield client.hotel.list(ArrivalDate='06/24/2015',
DepartureDate='06/25/2015',
CityId='0101')
self.write(resp.to_json())
application = Application([
(r'/hotel/list', HotelListHandler)
])
if __name__ == '__main__':
application.listen(9999)
ioloop.IOLoop().instance().start()
```
## 注意
由于个人使用原因，主要维护更新国际酒店的接口，其他功能未在生产环境中得到验证。
## LICENSE
[The MIT License](LICENSE)