用于访问sermonaudio.com api的官方python客户端库
sermonaudio的Python项目详细描述
sermonaudio.com API客户端库
这是访问最新版本的 SermonAudio.com原料药。
有关sermonaudio api的文档,请转到
api.sermonaudio.com。正确的python类型
在适当的地方进行了转换(例如,日期被转换
到datetime.date
对象)。api函数按api分组为模块
族,就像在主文档中一样(因此节点api端点帮助程序是
在node
模块中)。端点请求方法
前缀,如get
。
每个方法都包含详细的文档。如果你有任何问题 关于如何使用这些方法,或者觉得docstring可以改进, 向developer@sermonaudio.com发送消息。
安装说明
这个库是用python 3.6+编写的。请确保您有最新的
已安装OpenSSL的版本。如果你在Mac上,你可能需要使用
homebrew安装新的python版本
通过brew install python3 --with-brewed-openssl
更新的版本。
不幸的是,旧版本的openssl不支持tlsv1.2。旧版本
已经知道安全漏洞,所以我们的服务器将拒绝这样的连接。
确保为您的虚拟环境使用新的(酝酿的)python版本。
快速启动
api函数很简单。所有api方法都验证响应 从服务器,并从包装的响应返回逻辑值,或引发 例外。例如,返回单个结果的节点将只返回 如果存在,则在结果列表中的第一个项目。此外,对象 返回的对象被映射到正确的对象类型。下面是一些代码示例 让你开始。
import sermonaudio
from sermonaudio.node import Node
# You must set your API key before making any requests
sermonaudio.set_api_key('YOUR-API-KEY')
sermon = Node.get_sermon_info('261601260')
# TODO: Something with this sermon
for sermon in Node.get_sermons(broadcaster_id='faith'):
# TODO: Something with each sermon in the list
pass
所有方法都有docstring,因此您可以在 写你的申请表。我们鼓励您阅读完整的文档 以上为最完整、最新的详细信息。
本地化
当我们的本地化项目还处于早期阶段时,这个客户
图书馆知道这种支持。一般来说,如果我们支持
您的语言和密钥字符串将在服务器端本地化。但是,如果你是
在与用户不同的区域设置环境中运行时,可以覆盖
全局或每个请求的首选语言。您可以全局覆盖它
使用顶层set_preferred_language
函数。所有请求方法也接受
preferred_language_override
关键字参数,以便可以全局覆盖此参数。这个
通过httpAccept-Language
头传递,并应遵循该格式。
例如,en-US
为美国英语。