访问liquid planner项目管理工具的rest api的python库

pyliquidplanner的Python项目详细描述


PyliquidPlanner公司[构建状态](https://travis-ci.org/impulse-cloud/pyliquidlanner.svg?branch=master)(https://travis ci.org/impulse cloud/pyliquidplanner)


liquid planner rest api的python包装器。


最近,该库在pypi中不可用,但可以从github安装:

```
pip install git+git://github.com/impulse cloud/pyliquidlaner.git
`````

/PyliquidPlanner/tarball/master
```

/帮助/类型)查看哪些字段可用。


使用您的Liquid Planner登录来构造一些凭据:

``python
>;>然后创建一个api实例:

``python
>;>from liquidplanner import liquidplanner
>;>lp=liquidplanner(credentials)
```

例如,下面是工作区中所有项目的列表:

``python
>;>projects=lp.projects.all()
>;>p in projects:
>;>p打印"名称"
```

其他实体需要指定工作区。当实例化时,api请求一个可用工作区的列表,并默认为第一个返回的工作区。您可以通过传递"使用优先工作区"参数来禁用此检查。

``python
>;lp=liquidplanner(凭据,使用优先工作区=false)
````

>然后必须手动设置api的"工作区id"。

``python
>;workspace s=lp.workspaces.all()
>;>;lp.workspace\u id=workspaces[1]['id']
````

\api目前支持以下实体:

*account
*workspaces
*activities
*checklist items
*clients
*comments
*custom fields
*documents
*events
*folders
*links
*members
*里程碑
*packages
*projects
*tags
*tasks
*teams
*timesheets
*tree items
*webhooks

这样做是为了通过返回的对象访问相关的
项(请参见下面的[关联对象](关联对象)。否则将按原样返回数据,但转换为python"datetime.datetime"对象的日期除外。

使用"all()"获取实体的完整列表。

``python
>;>;all_clients=lp.clients.all()
````
大多数api选项都受支持,包括:

*`include`-获取相关实体也
*`filters`-筛选返回的项列表
*`order`-排序结果顺序
*`limit`-限制返回的对象数

o
*`depth`-获取树项时的最大深度



注意:liquidplanner rest api要求用单个实体名称包装数据。例如`{client':{name':'my cl"}"。这个库负责外部部分,所以您只需要担心`{name':'my client'}`.

```python
>;>client=lp.clients.create({name':'myclient'})
````

ed.

`` python
>;>>client=lp.client s.update(1234,{'name':'new client name'})
````

{物体。这些属性具有主API终结点的所有功能。

例如,可以检索给定任务的注释:

``python
>;>task=lp.tasks.get(1234)
>;>comments=task.comments.all()
```

k:

`` python
>;>task=lp.tasks.get(1234)
>;>comment=task.comments.create({"description":"这是我的注释"})
````

更新和删除的工作类似。

注意:使用"include"参数来使关联对象可用于"all()"或"get()"请求。只有外部对象具有可用的关联对象。


包装器不会尝试将便利方法筛选为其适用的对象类型,而是由开发人员使用Liquid Planner API指南。


支持的便利方法:

*树项
*更新分配
*重新排序分配
*删除分配nt
*事件、项目、任务等
*在
*任务之前/之后移动
*包之前/之后
*跟踪时间
*计时器开始/停止/提交/清除
*文档
*缩略图
*下载
*工作区
*注释流
*即将执行的任务
*更改ges

我想在将来支持的一些东西包括:

*支持"方便方法"(例如分配、重新排序)
*保存和检索附件
*更多测试



````
$python setup.py test
```


这将在您的环境中安装任何测试依赖项(mock),并执行单元测试。


请尝试包含任何新功能或错误修复的测试覆盖率。

如果PyliquidPlanner有任何问题,可以在GitHub上[记录问题](http://github.com/impulse-cloud/pyliquidPlanner/issues)。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java在JSP中添加自定义隐式对象   java MasterMindResource泄漏?   不同的c#java结果加密   java为什么安卓 studio显示“constraintlayout中缺少约束”错误?   java Make Logback将日志打印到文件中   java如何在Google应用程序引擎中设置日期时间?   jeditorpane如何阻止java HTMLEditorKit自动关闭我的标记   返回到Activity onCreate()时,不会调用java函数   java为什么我在这个对象上得到一个NullPointerException?   在java中,如何使用包含数组的参数调用图形方法?   java如何在Play framework 2应用程序中存储Akka参与者列表?   ssh使用java将文件从一个solaris 9复制到另一个solaris 9   网络Java服务器正在等待客户端响应   java Spring mvc从formBackingObject()重定向到页面   java Spark:JavaRDD<Tuple2>到javapairdd<>   java如何动态调用基类中由字符串值指定的子类方法?