用于解析以工作流语言编写的工作流的API服务器
agodashi的Python项目详细描述
阿戈达什
Agodashi是一个简单的restapi服务器。 它以工作流语言编写的工作流文件为输入,返回工作流类型、工作流版本和工作流参数模板。 目前支持的工作流语言如下:
将来,我们计划支持以下语言。在
安装并运行
Agodashi支持Python3.6或更新版本。在
$ pip3 install agodashi $ agodashi
Docker
我们也希望使用Docker启动。在
^{pr2}$使用
根据API规范,请检查SwaggerUI - Agodashi API Spec
Agodashi启动命令的帮助如下。在
$ agodashi --help usage: agodashi [-h][--host][-p][--debug] An API server for parsing workflows written in workflow languages optional arguments: -h, --help show this help message and exit --host Host address of Flask. (default: 127.0.0.1) -p , --port Port of Flask. (default: 8080) --debug Enable debug mode of Flask.
作为restapi请求的最简单示例,下面是POST /inspect-workflow
的结果。在
POST/inspect-workflow-F'wf_url=https://raw.githubusercontent.com/suecharo/agodashi/master/tests/resources/cwl/trimming_and_qc_packed.cwl'{"wf_params":"nthreads: 2 # default value of type \"int\". (optional)\nfastq_2: # type \"File\"\n class: File\n path: a/file/path\nfastq_1: # type \"File\"\n class: File\n path: a/file/path\n","wf_type":"CWL","wf_version":"v1.0"}
发展
您可以按如下方式启动开发环境。在
$ docker-compose -f docker-compose.dev.yml up -d --build
$ docker-compose -f docker-compose.dev.yml exec app bash
$ bash ./tests/lint_and_style_check/flake8.sh $ bash ./tests/lint_and_style_check/isort.sh $ bash ./tests/lint_and_style_check/mypy.sh
{a14}我们使用测试工具。在
$ pytest .
许可证
Apache-2.0。参见LICENSE。在
- 项目
标签: