与Illumina Clarity LIMS REST架构交互的API。
ua-clarity-api的Python项目详细描述
UA清晰度API
提供了一个简单的REST实现,用于Clarity端点。在
动机
旨在实现一种简单的方式来与clearity REST体系结构交互。在
特点
- 如果该端点存在,Get将执行批处理Get,否则它将返回与batch Get返回的响应类似的响应。在
- 调用方可以使用关键字添加查询以获取。在
- 缓存每个get以消除过多的get调用。在
- 如果失败,所有REST调用都将抛出异常。在
代码示例
fromua_clarity_apiimportua_clarity_apiapi=ua_clarity_api.ClarityApi(host,username,password)uris_files=api.download_files("some file uri")data=api.get("some endpoint")
安装
^{pr2}$测试
pip install --update nose cd ./repo cd ./tests nosetests test_ua_clarity_api.py
如何使用
- 您需要使用正确的主机和用户名/密码来实例化一个ClarityApi对象来访问该主机的端点。在
- Get可以从端点检索资源,并且可以利用带有“parameters”关键字的查询。在
- 如果给定适当的端点和格式良好的有效负载,Put和Post可以更新或创建新的资源。在
- 删除可以从终结点删除资源。在
- Download_files将从文件uri的列表中创建临时文件,并将它们作为uri:tempfile的字典映射返回。在
学分
sterns1raflopjrRyanJohannesBland
许可证
麻省理工学院
- 项目
标签: