servaldna REST接口的Python客户端
pyserval的Python项目详细描述
用于serval dna REST接口的Python客户机
在python中提供一个与servaldna的REST接口交互的客户机
功能
支持以下REST功能:
- 钥匙圈
- 根茎
- 网状结构
- 网状
- 路线
有关特定端点的文档,请参考The serval-dna documentation
依赖关系
在v0.4
之前,代码与python2.7&3.4+兼容。从v0.5
起,您将需要Python3.6+
唯一的外部运行时依赖项是requests。这应该由pip根据包元数据自动安装。在
开发依赖关系如下:
自动格式检查是使用black和pre-commit完成的。在
为了运行测试,您将需要hypothesis、pytest和{a7}作为覆盖率报告。在
要安装所有依赖项(运行时和开发/测试),请运行pip install -r requirements.txt
安装
从v0.4
起,版本将上载到PyPi,因此您只需按名称安装即可
pip install pyserval
发展
为了使代码具有合理的格式,提供了一个格式检查预提交钩子。用于检查/重新格式化的工具是black。请注意,钩子本身不进行任何重新格式化,它只是通知您文件的格式不正确。您需要自己使用black $FILEPATH
重新格式化。在
测试要求您安装来自serval-dna的servald
二进制文件,并在您的$PATH
中可用。为了有一个一致的测试环境,/tmp/pyserval-tests/
将被用作$SERVALINSTANCE_PATH
。在
- 克隆项目
- 将项目安装到python路径
- 你可能想用虚拟机
- 您可能还想使用
pip install -e .
进行可编辑安装
- 使用
pip install -r requirements.txt
安装开发依赖项 - 使用
pre-commit install
安装git pre-commit hook - 用于测试:在项目根运行
pytest --cov=pyserval
- 项目
标签: