Merge pull request #11 from yunpian/develop

Develop

Author: dzh

MANIFEST.in

@@ -1,4 +1,3 @@
 recursive-exclude tests *
-include LICENSE README.md tox.ini
-include yunpian_python_sdk/yunpian.ini
+include LICENSE README.rst tox.ini
 recursive-include docs *

README.rst

@@ -0,0 +1,73 @@
+yunpian-python-sdk
+==================
+
+`云片 <https://www.yunpian.com/>`__ SDK
+
+快速开始
+--------
+
+-  安装SDK
+
+   .. code:: python
+
+       pip install yunpian-python-sdk
+
+   **注**:
+   master是最新稳定版,发布版本见\ `PyPI <https://pypi.python.org/pypi>`__
+
+-  使用YunpianClient 
+
+   .. code:: python
+     
+        from yunpian_python_sdk.model import constant as YC
+        from yunpian_python_sdk.ypclient import YunpianClient
+        # 初始化client,apikey作为所有请求的默认值
+        clnt = YunpianClient('apikey')
+        param = {YC.MOBILE:'18616020***',YC.TEXT:'【云片网】您的验证码是1234'}
+        r = clnt.sms().single_send(param)
+        # 获取返回结果, 返回码:r.code(),返回码描述:r.msg(),API结果:r.data(),其他说明:r.detail(),调用异常:r.exception()
+        # 短信:clnt.sms() 账户:clnt.user() 签名:clnt.sign() 模版:clnt.tpl() 语音:clnt.voice() 流量:clnt.flow()
+
+**注**:
+v1.0.0不兼容之前版本\ `0.0.8 <https://github.com/yunpian/yunpian-python-sdk/releases/tag/0.0.8>`__
+
+配置说明 (默认配置就行)
+-----------------------
+-  构造器配置
+
+   -  ``YunpianClient('apikey')``
+   -  ``YunpianClient('apikey',conf)``,
+      conf字典key详见model.constant.YP\_\*
+
+-  apikey的优先级:接口的param[APIKEY] > 构造器的apikey > 构造器的conf[YP\_APIKEY]
+
+源码说明
+--------
+-  接口参数的apikey可以不传，因为所有接口默认传入`YunpianClient`构造时的apikey
+-  接口默认使用v2版本,可以在调用时指定版本,如\ ``clnt.sms().version('v1').single_send(param)``
+-  API单元测试目录tests,支持tox
+-  分支说明: master是最新发布版本,develop是待发布的分支(开源贡献可以pull request到develop分支)
+
+联系我们
+--------
+
+`云片支持
+QQ <https://static.meiqia.com/dist/standalone.html?eid=30951&groupid=0d20ab23ab4702939552b3f81978012f&metadata=%7B%22name%22:%22github%22%7D>`__
+
+SDK开源QQ群: 106469530
+
+.. image:: docs/sdk_qq.jpeg
+   :height: 60px
+   :width: 60px
+   :scale: 15%
+
+文档链接
+--------
+
+-  `API文档 <https://www.yunpian.com/api2.0/guide.html>`__
+
+可选SDK
+-------
+
+-  https://github.com/yunpian/sms/tree/master/yunpian/python/ypclient
+   支持py2/3

README.md renamed to docs/README.md

@@ -16,32 +16,32 @@ from yunpian_python_sdk.model import constant as YC
 from yunpian_python_sdk.ypclient import YunpianClient
 
 #初始化client,apikey作为所有请求的默认值
-clnt = YunpianClient('apikey');
+clnt = YunpianClient('apikey')
 
-param = {YC.MOBILE:'18616020***',YC.TEXT:'【云片网】您的验证码是1234'};
-r = clnt.sms().single_send(param);
+param = {YC.MOBILE:'18616020***',YC.TEXT:'【云片网】您的验证码是1234'}
+r = clnt.sms().single_send(param)
 #获取返回结果, 返回码:r.code(), 返回码描述:r.msg(),API结果:r.data(),其他说明:r.detail(),调用异常:r.exception()
 
 #短信:clnt.sms() 账户:clnt.user() 签名:clnt.sign() 模版:clnt.tpl() 语音:clnt.voice() 流量:clnt.flow()
 ```
 **注**: v1.0.0不兼容之前版本[0.0.8](https://github.com/yunpian/yunpian-python-sdk/releases/tag/0.0.8)
 
 ## 配置说明 (默认配置就行)
-- 默认配置文件 yunpian_python_sdk/yunpian.ini
 - 构造器配置
     - `YunpianClient('apikey')`
     - `YunpianClient('apikey',conf)`, conf字典key详见model.constant.YP_*
 - apikey的优先级:接口的param[APIKEY] > 构造器的apikey > 构造器的conf[YP_APIKEY]
 
 ## 源码说明
+- 接口方法参数的apikey默认传入`YunpianClient`构造时的apikey
 - 接口默认使用v2版本,可以在调用时指定版本,如`clnt.sms().version('v1').single_send(param)`
 - API单元测试目录tests,支持tox.ini
 - 分支说明: master是最新发布版本,develop是待发布的分支(开源贡献可以pull request到develop分支)
 
 ## 联系我们
 [云片支持 QQ](https://static.meiqia.com/dist/standalone.html?eid=30951&groupid=0d20ab23ab4702939552b3f81978012f&metadata={"name":"github"})
 
-SDK开源QQ群
+SDK开源QQ群: 106469530
 
 <img src="docs/sdk_qq.jpeg" width="15%" alt="SDK开源QQ群"/>
 

yunpian_python_sdk/yunpian.ini renamed to docs/yunpian.ini

@@ -8,7 +8,7 @@
 from setuptools import find_packages, setup
 
 
-with open(path.join(path.abspath(path.dirname(__file__)), 'README.md'), encoding='utf-8') as f:
+with open(path.join(path.abspath(path.dirname(__file__)), 'README.rst'), encoding='utf-8') as f:
     LONG_DESC = f.read()
 
 KWARGS = dict(
@@ -30,7 +30,6 @@
         'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',

setup.py

@@ -4,11 +4,9 @@
 
 @author: dzh
 '''
-import sys
 import unittest
 
 import requests
-
 from yunpian_python_sdk.model.constant import YP_VERSION, HTTP_CONN_TIMEOUT
 from yunpian_python_sdk.ypclient import _YunpianConf
 
@@ -29,20 +27,21 @@ def test_YunpianConf(self):
         self.assertEqual(conf.conf(YP_VERSION), "v2")
         self.assertEqual(conf.conf(HTTP_CONN_TIMEOUT), "10")
 
-    def _test_uri(self):
+    def test_uri(self):
         url = '{}/{}/{}/{}'.format('https://test-api.yunpian.com', 'v2', 'user', 'get.json')
         self.assertEqual('https://test-api.yunpian.com/v2/user/get.json', url)
 
 
     def _test_name(self):
-        print(sys.modules[__name__])
+        import sys
+        self.assertEqual('tests.test_ypclient', sys.modules[__name__].__name__)
 
     def _test_requests(self):
         r = requests.get('https://github.com/dzh')
-        print(r.status_code)
+        self.assertEqual(r.status_code, 200)
 
         r = requests.get('https://www.yunpian.com/')
-        print(r.status_code)
+        self.assertEqual(r.status_code, 200)
 
 
 if __name__ == "__main__":

tests/test_ypclient.py

@@ -11,10 +11,9 @@
 from yunpian_python_sdk.ypclient import YunpianClient
 
 
-# from yunpian_python_sdk.model.constant import
 class TestYunpianApi(unittest.TestCase):
 
-    APIKEY = '2daab1114c69c9c41d1172b0ad8c392d'
+    APIKEY = '******'
 
     CONF = {YP_FLOW_HOST:'https://test-api.yunpian.com', YP_SIGN_HOST:'https://test-api.yunpian.com',
             YP_SMS_HOST:'https://test-api.yunpian.com', YP_TPL_HOST:'https://test-api.yunpian.com',

tests/testapi/__init__.py

@@ -14,7 +14,7 @@
 class TestFlowApi(TestYunpianApi):
     '''Test FlowApi'''
 
-    def _test_get_package(self):
+    def test_get_package(self):
         clnt = self._clnt
 
         r = clnt.flow().get_package()
@@ -24,7 +24,7 @@ def _test_get_package(self):
         r = clnt.flow().version(VERSION_V1).get_package()
         self.show(r)
 
-    def _test_recharge(self):
+    def test_recharge(self):
         clnt = self._clnt
 
         param = {MOBILE : '18616020000', SN : '1008601'}
@@ -35,7 +35,7 @@ def _test_recharge(self):
         r = clnt.flow().version(VERSION_V1).recharge(param)
         self.show(r)
 
-    def _test_pull_status(self):
+    def test_pull_status(self):
         clnt = self._clnt
 
         r = clnt.flow().pull_status()

tests/testapi/test_flow.py

@@ -16,22 +16,22 @@ class TestSignApi(TestYunpianApi):
     '''Test SignApi'''
 
 
-    def _test_add(self) :
+    def test_add(self) :
         clnt = self._clnt
 
         param = {SIGN:'你好吗', NOTIFY:'true', APPLYVIP:'false', ISONLYGLOBAL:'false', INDUSTRYTYPE:'其他'}
         r = clnt.sign().add(param)
         self.show(r)
 
-    def _test_update(self):
+    def test_update(self):
         clnt = self._clnt
 
         param = {OLD_SIGN :'你好吗', SIGN : '我很好', NOTIFY : 'true', APPLYVIP :'false',
                 ISONLYGLOBAL: 'false', INDUSTRYTYPE: '其他'}
         r = clnt.sign().update(param)
         self.show(r)
 
-    def _test_get(self) :
+    def test_get(self) :
         clnt = self._clnt
 
         param = {PAGE_NUM : '1', PAGE_SIZE:"3"}

tests/testapi/test_sign.py

@@ -15,44 +15,44 @@
 class TestSmsApi(TestYunpianApi):
     '''Test SmsApi'''
 
-    def _test_single_send(self):
+    def test_single_send(self):
         clnt = self._clnt;
 
         param = {MOBILE:'18616020000', TEXT:'【云片网】您的验证码是1234'}
         r = clnt.sms().single_send(param)
         self.show(r)
 
-    def _test_batch_send(self):
+    def test_batch_send(self):
         clnt = self._clnt
 
         param = {MOBILE:'18616020000', TEXT:'【云片网】您的验证码是1234'}
         r = clnt.sms().batch_send(param)
         self.show(r)
 
-    def _test_multi_send(self):
+    def test_multi_send(self):
         clnt = self._clnt
         param = {MOBILE : '18616020610,18616020611',
             TEXT: clnt.urlEncodeAndJoin(['【哈哈哈】您的验证码,是1234', '【哈哈哈】您的验证码是1234'])}
         r = clnt.sms().multi_send(param)
         self.show(r)
 
     # deprecated
-    def _test_tpl_single_send(self):
+    def test_tpl_single_send(self):
         clnt = self._clnt
 
         param = {MOBILE:'18616020000', TPL_ID:'1', TPL_VALUE:'#company#=云片网'}
         r = clnt.sms().tpl_single_send(param)
         self.show(r)
 
     # deprecated
-    def _test_tpl_batch_send(self):
+    def test_tpl_batch_send(self):
         clnt = self._clnt;
 
         param = {MOBILE :'18616020000', TPL_ID :'1', TPL_VALUE :'#company#=云片网'}
         r = clnt.sms().tpl_batch_send(param)
         self.show(r)
 
-    def _test_pull_status(self):
+    def test_pull_status(self):
         clnt = self._clnt;
 
         param = {PAGE_SIZE :'20'}
@@ -63,7 +63,7 @@ def _test_pull_status(self):
         r = clnt.sms().version(VERSION_V1).pull_status(param)
         self.show(r)
 
-    def _test_pull_reply(self):
+    def test_pull_reply(self):
         clnt = self._clnt;
 
         param = {PAGE_SIZE :'20'}
@@ -74,7 +74,7 @@ def _test_pull_reply(self):
         r = clnt.sms().version(VERSION_V1).pull_reply(param)
         self.show(r)
 
-    def _test_get_record(self):
+    def test_get_record(self):
         clnt = self._clnt;
 
         param = {START_TIME : '2013-08-11 00:00:00', END_TIME : '2016-12-05 00:00:00', PAGE_NUM : '1',
@@ -86,7 +86,7 @@ def _test_get_record(self):
         r = clnt.sms().version(VERSION_V1).get_record(param)
         self.show(r)
 
-    def _test_get_black_word(self):
+    def test_get_black_word(self):
         clnt = self._clnt
 
         param = {TEXT: '高利贷,发票'}
@@ -99,14 +99,14 @@ def _test_get_black_word(self):
 
 
     # deprecated
-    def _test_send(self):
+    def test_send(self):
         clnt = self._clnt
 
         param = {MOBILE:'18616020000', TEXT : '【云片网】您的验证码是1234'}
         r = clnt.sms().version(VERSION_V1).send(param)
         self.show(r)
 
-    def _test_get_reply(self):
+    def test_get_reply(self):
         clnt = self._clnt
 
         param = {START_TIME: '2013-08-11 00:00:00', END_TIME : '2016-12-05 00:00:00', PAGE_NUM : '1',
@@ -119,14 +119,14 @@ def _test_get_reply(self):
         self.show(r)
 
     # deprecated
-    def _test_tpl_send(self):
+    def test_tpl_send(self):
         clnt = self._clnt
 
         param = {MOBILE : '18616020000', TPL_ID : '1', TPL_VALUE :'#company#=云片网'}
         r = clnt.sms().version(VERSION_V1).tpl_send(param)
         self.show(r)
 
-    def _test_count(self):
+    def test_count(self):
         clnt = self._clnt;
 
         param = {START_TIME : '2013-08-11 00:00:00', END_TIME :'2016-12-05 00:00:00', PAGE_NUM : '1',