看板api客户端库
kanboard的Python项目详细描述
看板api的客户端库。
- 作者:Frédéric Guillot
- 许可证:麻省理工学院
安装
pip install kanboard
此库与python>;=3.5兼容。
注意:对python 2.7的支持已从版本1.1.0中删除。
示例
方法和参数与 official documentation。
python方法动态映射到api过程。必须使用命名参数。
默认情况下,调用是同步进行的,这意味着它们将阻塞程序直到完成。
创建新的团队项目
importkanboardkb=kanboard.Client('http://localhost/jsonrpc.php','jsonrpc','your_api_token')project_id=kb.create_project(name='My project')
以用户身份验证
importkanboardkb=kanboard.Client('http://localhost/jsonrpc.php','admin','secret')kb.get_my_projects()
创建新任务
importkanboardkb=kanboard.Client('http://localhost/jsonrpc.php','jsonrpc','your_api_token')project_id=kb.create_project(name='My project')task_id=kb.create_task(project_id=project_id,title='My task title')
异步I/O
客户端还公开异步/等待样式的方法调用。类似于同步调用(见上文)。 方法名映射到api方法。
要调用异步调用,方法名必须附加_async。例如,同步调用 可以通过调用create_project_async使tocreate_project异步。
importasyncioimportkanboardkb=kanboard.Client('http://localhost/jsonrpc.php','jsonrpc','your_api_token')loop=asyncio.get_event_loop()project_id=loop.run_until_complete(kb.create_project_async(name='My project'))
importasyncioimportkanboardasyncdefcall_within_function()kb=kanboard.Client('http://localhost/jsonrpc.php','jsonrpc','your_api_token')returnawaitkb.create_project_async(name='My project')loop=asyncio.get_event_loop()project_id=loop.run_until_complete(call_within_function())
请参阅official API documentation以获取 方法和参数。