lob python绑定
lob的Python项目详细描述
lob python
这是lob.com api的python包装器。请参阅完整的lob.com文档here。为了获得最佳结果,请确保使用的是lob api的the latest version和最新版本的python包装器。
这个库支持活动的python版本(即还没有到达生命尽头的版本)以及pypy和pypy 3。 当前支持的版本包括:
- python 2.7版
- Python3.5
- python 3.6
- Python3.7
- 皮比
- Pypy 3
目录
开始
lob python包装器以面向对象的方式工作。也就是说,要进行调用,必须对类调用方法,返回类型是python对象。要获取任何对象的dict
,可以调用该对象的to_dict()
方法。
下面是可用的lob服务的一般概述,单击此处可阅读更多内容。
请通读官方的API Documentation,以全面了解每个端点的期望值。
注册
首先,您需要首先在Lob.com创建一个帐户,并获取您的测试和活动api密钥。
创建帐户后,可以从Settings Panel访问api密钥。
安装
您可以使用pip
来安装包。
pip install lob
要初始化包装器,请导入lob
,并设置api_key
importloblob.api_key='your-api-key'//setanapiversion(optional)lob.api_version='api-version'
使用量
我们提供了一个可以在examples/中运行的示例脚本,其中包含如何将lob python包装器与一些核心端点一起使用的示例。
示例
我们提供了各种示例供您尝试here。
有一些简单的脚本演示如何创建所有核心lob对象(支票、信件、明信片)。以及使用其他库和外部文件的更复杂的示例。
API文档
- Introduction
- Versioning
- Errors
- Rate Limiting
- Webhooks
- Cancellation Windows
- Scheduled Mailings
- Metadata
- HTML Templates
- Asset URLs
- 地址
- US验证API
- int'l验证api
- 明信片API
- 字母api
- 检查api
- 附录
测试
lob python使用Pipenv来管理开发环境和依赖项。
通过运行
$ pipenv install --dev $ pipenv shell
您可以使用主目录中的命令LOB_API_KEY=YOUR_TEST_API_KEY nosetests
运行所有测试。
$ LOB_API_KEY=YOUR_TEST_API_KEY nosetests
发布
lob python包含bumpversion作为开发依赖项。这个 到更改版本号时应使用ol,因为它将确保正确更新版本号,并且 一贯地。
运行bumpversion将增加指定的版本部分(major
,minor
,patch
),提交更改,
并贴上标签。
$ bumpversion <part>
在版本被碰撞之后,您可以推动更改和标记。
$ git push origin head $ git push origin --tags
最后,创建发行版并使用twine将其推送到pypi。
$ python setup.py sdist ... Writing lob-4.0.0/setup.cfg Creating tar archive removing 'lob-4.0.0'(and everything under it) $ twine upload dist/lob-4.0.0.tar.gz
版权所有©2013-2019 lob.com
在mit许可下发布,可以在LICENSE.txt
的存储库中找到。