cpbm bss api的最小包装。
cpbmapi的Python项目详细描述
cpbm-bss-api包装器
=========
此项目是cpbm-bss-api的最小包装器。其
目的是提供一个独立于cpbm版本的cpbm bss库。
而不是为所有cpbm bss功能提供函数存根，此库与cpbm bss api文档一起使用，而“request”函数接受每个调用所需的json值。
使用此库有两种方法：
1。“api”类可以从任何代码实例化。它有一个“request”方法，用于对cpbm bss api进行api调用。此方法
获取请求参数的python字典，并返回带有结果的python字典。“cli”类是“api”的一个子类，旨在成为一个方便的
类，用于使用由“docopt”解析的命令行参数填充“api”构造函数的独立脚本
。命令行参数可以
直接传入，也可以添加到json文件中，并且“--json”标志可以
用于引用json文件路径。在
包中包含了一个“cli-example.py”文件，它给出了一个如何使用这个用例的工作示例。
这个库的核心是一个单独的“request”方法，描述如下。
``python
``api.request（self，rest-path，params={}，payload={}，method=get'）
``````
``sphinx
返回结果的python字典或不返回结果。
：param rest_path：附加到“端点”。记住包含前导'/'
：键入rest_path:str或unicode
：param params:要添加到url的查询参数
：type params:dict
：param payload:要传递到服务器的对象（由于非标准的bss api实现，可能无法按预期工作
：
：键入payload:dict
：param method:request method[get post put delete]
：type method:str或unicode
：返回：请求结果作为python字典
：rtype:dict或none
`````
**使用父“api”类的示例：*
```python
api=api（api_key=“your_api_key”，
secret_key=“您的密钥”，
endpoint=“http://127.0.0.0.1:8080/portal/api/portal/api”）
>accounts=api.request（'/accounts'）
```
**以“cli”子类为例：**
```python
api=cli（\\\\\\\\\\\\\\\\\\\\\\\\是通过的`管道`.
``bash
$pip安装cpbmapi
`````
或者，可以直接下拉源代码，手动安装。
核心功能记录在案但值得花一分钟来更好地描述“cli”用例。
``bash
$./cli-example.py-help
用法：
cli-cli-example.py[--json=<；arg>；][--api-api-key=<；arg>；--secret-key=<；arg>；][options]
>
```bash.py
>
>
=--json-json=<；arg；path.py到与相同名称的json配置文件
选项（前面没有--）。
--api_key=<；arg>；cpbm api key.
--secret_key=<；arg>；cpbm secret key.
--endpoint=<；arg>；cpbm endpoint
[默认值：http://127.0.0.1:8080/portal/api]。
--日志记录=<；arg>；布尔值可打开或注销日志[默认值：true]。
--log=<；arg>；要使用的日志文件[默认值：logs/cpbmapi.log]。
--清除日志=<；arg>；每次API对象删除日志时创建t
[默认值：true]。
```
=========
此项目是cpbm-bss-api的最小包装器。其
目的是提供一个独立于cpbm版本的cpbm bss库。
而不是为所有cpbm bss功能提供函数存根，此库与cpbm bss api文档一起使用，而“request”函数接受每个调用所需的json值。
使用此库有两种方法：
1。“api”类可以从任何代码实例化。它有一个“request”方法，用于对cpbm bss api进行api调用。此方法
获取请求参数的python字典，并返回带有结果的python字典。“cli”类是“api”的一个子类，旨在成为一个方便的
类，用于使用由“docopt”解析的命令行参数填充“api”构造函数的独立脚本
。命令行参数可以
直接传入，也可以添加到json文件中，并且“--json”标志可以
用于引用json文件路径。在
包中包含了一个“cli-example.py”文件，它给出了一个如何使用这个用例的工作示例。
这个库的核心是一个单独的“request”方法，描述如下。
``python
``api.request（self，rest-path，params={}，payload={}，method=get'）
``````
``sphinx
返回结果的python字典或不返回结果。
：param rest_path：附加到“端点”。记住包含前导'/'
：键入rest_path:str或unicode
：param params:要添加到url的查询参数
：type params:dict
：param payload:要传递到服务器的对象（由于非标准的bss api实现，可能无法按预期工作
：
：键入payload:dict
：param method:request method[get post put delete]
：type method:str或unicode
：返回：请求结果作为python字典
：rtype:dict或none
`````
**使用父“api”类的示例：*
```python
api=api（api_key=“your_api_key”，
secret_key=“您的密钥”，
endpoint=“http://127.0.0.0.1:8080/portal/api/portal/api”）
>accounts=api.request（'/accounts'）
```
**以“cli”子类为例：**
```python
api=cli（\\\\\\\\\\\\\\\\\\\\\\\\是通过的`管道`.
``bash
$pip安装cpbmapi
`````
或者，可以直接下拉源代码，手动安装。
核心功能记录在案但值得花一分钟来更好地描述“cli”用例。
``bash
$./cli-example.py-help
用法：
cli-cli-example.py[--json=<；arg>；][--api-api-key=<；arg>；--secret-key=<；arg>；][options]
>
```bash.py
>
>
=--json-json=<；arg；path.py到与相同名称的json配置文件
选项（前面没有--）。
--api_key=<；arg>；cpbm api key.
--secret_key=<；arg>；cpbm secret key.
--endpoint=<；arg>；cpbm endpoint
[默认值：http://127.0.0.1:8080/portal/api]。
--日志记录=<；arg>；布尔值可打开或注销日志[默认值：true]。
--log=<；arg>；要使用的日志文件[默认值：logs/cpbmapi.log]。
--清除日志=<；arg>；每次API对象删除日志时创建t
[默认值：true]。
```
欢迎加入QQ群-->： 979659372
