pivotaltracker 0.0.3

概述

此模块为PivotAltracker API提供了一个简单的pythonic接口。 它还为pivotal提供了一个简单的命令行接口。

快速启动

这是使用pivotal的主要api。首先，您需要来自pivotal的api令牌。 您可以在配置文件设置中生成一个：<；https://www.pivotaltracker.com/profile>；。

接下来，您只需创建一个客户机：

import pivotaltracker
client = pivotaltracker.Client(token="YOUR API TOKEN")

现在您可以在该客户机上执行任何api方法。所有方法调用都将返回python字典。 在我创建api文档之前，您可以在docstrings中找到详细的文档。 在此期间，这里有一个简短的摘要：

• get_项目（项目id）
• get_all_项目（）
• get\u story（项目id，故事id）
• get_stories（项目id，查询=无，限制=无，偏移=无）
• get_迭代（项目id，limit=none，offset=none）
• get_done_迭代（项目id，limit=none，offset=none）
• get_current_迭代（项目id，限制=无，偏移=无）
• get_backlog_迭代（项目id，limit=none，offset=none）
• add_story（项目ID、名称、描述、story_type、请求者=无、估计数=无、当前状态=无、标签=无）
• update_story（项目ID，story_id，名称=无，说明=无，请求者=无，story_type=无，估计=无，当前状态=无，标签=无）
• 删除故事（项目ID，故事ID）
• 添加注释（项目ID，故事ID，文本，作者=无）
• deliver所有已完成的故事（项目ID）

源代码

您可以在github上贡献源代码：<；http://github.com/mjpizz/pivotaltracker>；

发行说明

• 0.0.3向工具添加了功能提交
• 0.0.2向工具添加了错误提交
• 0.0.1原始客户机api对象，非常基本的命令行工具（只提交琐事）

高级

命令行工具

只需在命令行上运行pt help即可查看选项。你第一次使用这个工具的时候， 它将引导您完成创建api密钥和设置配置的过程。

以后会有更多的文档。