未知
deskapi的Python项目详细描述
deskapi是一个围绕Desk.com REST API的python包装器。它 为文章、主题和翻译提供python包装器。 deskapi与python 2.6、2.7和3.3兼容。
开始
通过DeskSession对象管理对桌面api的访问。 要实例化会话,您需要一个站点名和身份验证 信息。如果desk.com站点是http://example.desk.com,则 网站名称将是example。身份验证信息是任何valid Requests auth object。最简单的是提供用户名 和密码。例如:
>>> from deskapi.models import DeskSession >>> session = DeskSession( ... sitename='example', ... auth=('nathan@example.com', '53kr17') ... )
一旦有了会话id,就可以检索Articles:
>>> articles = session.articles()
Article fields映射到python属性:
>>> article = articles[0] >>> article.subject 'Help Topic' >>> article.in_support_center True
集合和对象
desk api将deskapi提供的信息建模为 “集合”和“对象”。上的articles()方法 DeskSesssion返回一个集合。集合可以迭代 支持索引访问。集合可以创建新成员 就其本身而言。
集合的每个成员都是一个桌面对象。桌面对象支持 属性对其字段的访问,以及更新这些字段。
收藏
创建成员
可以通过调用^{tt6}创建集合的新成员$ 方法,将字段作为关键字参数传入。
>>> new_article = articles.create( ... title='New Article', ... body='Some content.', ... )
主题
Topics可通过DeskSession上的topics()方法访问。
翻译
Translations可通过的translations属性访问 文章反对。翻译集略有不同 比其他收藏品。它不允许索引访问,而是执行 类似于dict,由语言环境设置:
>>> translations = article.translations >>> len(translations) 2 >>> translations['es'].subject 'Tema de Ayuda'
对象
更新对象
您可以更改对象并将其保存回桌面。
>>> article.body = 'Test Content'
>>> article.save()
或者可以使用update方法更新
桌面中的信息,无需更新本地python对象。这个
以下内容相当于save示例:
>>> article = article.update(body='Test Content')
save和update都返回更新的对象。
许可证
根据BSD许可证提供;有关详细信息,请参阅许可证。
新闻
0.1
发布日期:2013年9月5日
- 初始版本
- 支持文章、主题、翻译