REANA-Client

关于

REANA-Client 是 REANA 可重复和可重用研究数据分析平台的一个组件。它提供了一个命令行工具，允许研究人员提交、运行和管理他们的计算工作流程。

• 使用输入代码和数据初始化工作区
• 在远程计算云上运行计算工作流程
• 列出提交的工作流程并查询其状态
• 下载已完成工作流程的结果

安装

$ # create new virtual environment
$ virtualenv ~/.virtualenvs/reana
$ source ~/.virtualenvs/reana/bin/activate
$ # install reana-client
$ pip install reana-client

用法

有关如何安装和使用 REANA 的详细信息，请参阅 docs.reana.io。

有用链接

• REANA 项目主页
• REANA 用户文档
• REANA 用户支持论坛
• REANA-Client 版本发布
• REANA-Client 开发者文档
• REANA-Client 已知问题
• REANA-Client 源代码

变更日志

0.9.3 (2024-03-13)

构建

• appimage: 升级到 Python 3.8.18 (#704) (783c17a)

错误修复

• 状态: 显示停止的工作流程的正确持续时间 (#701) (b53def8)，关闭 #699

代码重构

• docs: 从 reST 移动到 Markdown (#703) (c9c4d53)

代码风格

• black: 使用 black v24 格式化 (#702) (02dc830)

测试套件

• snakemake: 允许在 Python 3.11+ 上运行 Snakemake 7 测试 (#700) (8ad7ff1)，关闭 #655

持续集成

• commitlint: 添加提交消息检查器 (#695) (2de7d61)
• commitlint: 允许发布提交风格 (#708) (f552752)
• commitlint: 检查具体 PR 编号的 presence (#698) (fa5b7c7)
• pytest: 安装 tests 包变体而不是 all (#703) (fe0b00a)
• release-please: 初始配置 (#695) (5b278f1)
• shellcheck: 修复退出代码传播 (#698) (fe696ea)

文档

• 作者: 贡献者完整列表 (#705) (875997c)

0.9.2 (2023-12-19)

• 更改了 validate 命令，当规范文件不是有效的 YAML 文件时，显示详细的错误。
• 更改规范文件的验证，以显示改进的验证警告，这些警告还指示文件中意外属性的位置。
• 修复了 create_workflow_from_json API 函数，使其始终从服务器加载并发送工作流程规范。
• 修复了 list 命令，当通过 --sort 选项对返回的工作流程运行进行排序时，接受不区分大小写的列名。
• 修复了不包含 inputs 子句的工作流程的 run 包装命令。

0.9.1 (2023-09-27)

• 添加了对 Python 3.12 的支持。
• 添加了 prune 命令，用于删除给定工作流程的所有中间文件。请谨慎使用。
• 修改 open 命令，在交互式会话在一段时间无活动后自动关闭时通知用户。
• 修改 validate 命令，在检查 REANA 规范文件时显示非关键验证警告。
• 修复 list 命令，以正确列出按运行编号或工作区大小排序的工作流程。
• 修复 du 命令的帮助信息中的拼写错误。
• 修复 validation --environments 命令，以正确处理完全限定制的镜像名称。

0.9.0 (2023-01-26)

• 添加对 Python 3.11 的支持。
• 添加对 .gitignore 和 .reanaignore 的支持，以指定不应上传到 REANA 的文件。
• 添加 retention-rules-list 命令，以列出工作流程的保留规则。
• 通过将部分逻辑迁移到 reana-commons，更改 REANA 规范加载和验证功能。
• 更改 create 和 restart 命令，始终上传 REANA 规范文件。
• 更改 delete 命令，始终删除工作流程的工作区。
• 更改 delete_workflow Python API 函数，始终删除工作流程的工作区。
• 更改 download 命令，添加通过 -o - 选项将文件写入标准输出的可能性。
• 更改 list 命令，默认隐藏已删除的工作流程。
• 更改 list 命令，允许通过 --all 和 --show-deleted-runs 选项显示已删除的工作流程。
• 更改 list 和 status 命令，允许通过 --include-duration 选项显示工作流程的持续时间。
• 更改 mv 命令，允许在工作流程运行时移动文件。
• 更改 upload 命令，防止上传符号链接。
• 更改 validation --environment 命令，使用 Docker 注册表 v2 API 检查 Docker 镜像是否存在于 DockerHub 中。
• 修复 list 命令，以正确突出显示 REANA_WORKON 中指定的作业流程。
• 修复 secrets-delete 命令删除不存在密钥时的错误信息。
• 修复 start 命令，报告失败的作业流程作为错误。
• 修复 start 和 run 命令，以正确跟踪作业流程的执行，直至终止。
• 修复 status 命令，以尊重由 --format 选项提供的输出格式。
• 修复 upload 命令，报告输入目录是否在 REANA 规范文件的 files 部分中列出，反之亦然。
• 修复 validate --environment 命令，以检测 Docker 镜像名称中的非法空白字符。

0.8.1 (2022-02-15)

• 添加对创建 reana-client 独立 AppImage 可执行文件的支持。
• 添加对 Python 3.10 的支持。
• 为 create_workflow_from_json() Python API 函数添加工作流程名称验证。
• 修复错误信息的格式，并设置适当的退出状态代码。

0.8.0 (2021-11-24)

• 添加对运行和验证 Snakemake 工作流程的支持。
• 添加对 reana.yaml 中的 outputs.directories 的支持，允许轻松下载输出目录。
• 添加新的 quota-show 命令，以检索有关总 CPU 和磁盘使用情况以及配额限制的信息。
• 添加新的 info 命令，以检索有关集群的一般信息，例如可用工作区路径设置。
• 更改 validate 命令，添加通过 --server-capabilities 选项检查工作流程与服务器能力（如期望的工作区路径）的可能性。
• 更改 list 命令，添加通过 --filter 选项按工作流程状态过滤和通过工作流程名称搜索的可能性。
• 更改 list 命令，添加通过 -w 选项过滤和显示给定工作流程所有运行的可能性。
• 更改 list 命令，默认停止包括工作流程进度和工作区大小。请使用新选项 --include-progress 和 --include-workspace-size 来显示此信息。
• 更改 list --sessions 命令，显示交互式会话的状态。
• 更改 logs 命令，显示单个作业的启动和完成时间。
• 将 ls 命令更改以添加通过 --filter 选项按文件名、大小和最后修改值过滤的功能。
• 将 du 命令更改以添加通过 --filter 选项按文件名和大小过滤的功能。
• 更改 delete 命令以防止删除工作流程。
• 更改 Yadage 工作流程规范加载，使其在 reana-commons 中进行。
• 将 CWL 工作流程引擎更改为 cwltool 版本 3.1.20210628163208。
• 移除对 Python 2.7 的支持。请从现在开始使用 Python 3.6 或更高版本。

0.7.5 (2021-07-05)

• 更改工作流程验证以显示更详细的结果。
• 更改工作流程参数验证以警告每个步骤中误用的参数。
• 更改依赖关系以取消对 six 的锁定，以便客户端可以在更多环境中安装。
• 修复了环境映像验证，不再重复测试相同的映像。
• 修复了 upload_to_server() Python API 函数，在输入为非空值时静默跳过上传。

0.7.4 (2021-04-28)

• 将通配符模式添加到 ls 命令中。
• 将目录下载和通配符模式添加到 download 命令中。
• 更改 list 命令以默认包括已删除的工作流程。
• 修复了环境映像验证信息消息中 UIDs 错误切换的问题。

0.7.3 (2021-03-24)

• 将工作流程输入参数验证添加到 validate 命令中。
• 将工作流程环境映像（--environments）的可选验证添加到 validate 命令中。

0.7.2 (2021-01-15)

• 添加对 Python 3.9 的支持。
• 修复了上传文件时的异常处理。
• 修复了小的代码警告。
• 修复了来自用户导出的 REANA_SERVER_URL 的尾随斜杠问题。

0.7.1 (2020-11-10)

• 更改 ping 命令输出以包括 REANA 客户端和服务器版本信息。
• 修复了 upload 命令以正确显示错误。

0.7.0 (2020-10-20)

• 添加了 logs 命令的选项，可根据计算后端、Docker 映像、状态和步骤名称过滤作业日志。
• 添加了新的 restart 命令以重启先前运行或失败的工作流程。
• 允许在工作流程的 reana.yaml 中指定操作选项。
• 通过防止点作为工作流程名称的一部分来防止与重启运行混淆，从而改善了用户体验。
• 更改 du 命令输出格式。
• 更改文件加载以优化 CLI 性能。
• 更改 logs 命令以增强使用标记和颜色的格式化。
• 从 Bravado 更改为 requests 以提高下载性能。
• 更改 ping 命令以执行用户访问令牌验证。
• 更改默认设置以接受 reana.yaml 和 reana.yml 文件名。
• 更改 diff 命令以改进输出格式。
• 更改代码格式以遵守 black 编码风格。
• 更改文档以采用单页布局。

0.6.1 (2020-06-09)

• 通过锁定几个依赖项修复了 REANA 0.6.x 版本系列的安装问题。

0.6.0 (2019-12-27)

• 引入了用户秘密管理命令 secrets-add、secrets-list 和 secrets-delete。
• 增强 run 和 create 命令，允许通过 --workflow 标志指定工作流程。
• 引入了新的 version 命令以报告客户端版本。
• 修复了 upload 命令的行为，以处理上传非常大的文件。
• 通过删除免费上传参数简化了 run 命令。
• 将 cwltool 升级到 1.0.20191022103248。
• 在与自签名服务器证书通信时禁用 SSL 验证警告。

0.5.0 (2019-04-24)

• 在 reana.yaml 规范文件中引入了新的 resources 字段，允许声明工作流程运行所需的计算资源，例如通过 cvmfs 子字段声明的 CVMFS 存储库。
• 通过分组命令并为所有命令提供具体的使用示例来增强 reana-client 内嵌命令行文档（-help）。
• 增强 start 命令，允许覆盖输入参数（--parameter）并指定额外的操作选项（--option）。
• 介绍新的工作流run包装命令，该命令创建工作流，上传其输入数据和代码，并开始执行。
• 介绍新的工作流stop命令，用于停止运行中的工作流。
• 通过新的--json选项增强工作流logs命令的输出能力。
• 介绍新的工作流diff命令，用于比较两个工作流运行。
• 介绍新的工作流delete命令，用于删除一个或多个工作流运行。
• 介绍新的会话open命令，允许在流程工作区运行交互式会话，如Jupyter笔记本。
• 介绍新的会话close命令，用于关闭交互式会话。
• 将过去的workflows命令重命名为list，允许列出工作流运行和交互式会话。
• 介绍新的工作空间du命令，用于检查工作空间磁盘使用情况。
• 介绍新的工作空间mv命令，用于在工作空间内移动文件。
• 介绍新的工作空间rm命令，用于在工作空间内删除文件。
• 将过去的工作空间list命令重命名为ls，允许列出工作空间文件。通过新的--format选项增强其输出能力。
• 介绍新的API函数create_workflow_from_json()，允许开发人员和第三方系统直接从JSON规范创建工作流。

0.4.0 (2018-11-07)

• 增强测试套件并提高代码覆盖率。
• 将许可证更改为MIT。

0.3.1 (2018-09-25)

• 修改上传和下载命令，现在在没有提供参数的情况下，将上传/下载reana.yaml中指定的所有文件。
• 修复status命令的JSON输出模式。
• 升级CWL参考实现到版本1.0.20180912090223。
• 将串行工作流操作参数的名称从CACHING更改为CACHE。
• 添加对Python 3.7的支持。

0.3.0 (2018-08-10)

• 添加对串行工作流的支持。

• 将CLI重构为扁平设计

  • 移除inputs/outputs/code，所有内容都是通过上传/下载/列表命令管理的文件。
  • 移除workflow命令，工作流通过create/start/status管理。

• 移除analyes命令，现在validate是顶级命令。

• 在详细模式下，status现在显示所选工作流的进度和当前命令。

• 使用REANA服务器需要使用访问令牌。

• 修复上传二进制文件时的错误。

• 在为串行工作流使用start时，支持添加工作流引擎参数。

• 改进错误消息。

0.2.0 (2018-04-20)

• 添加对通用工作流语言工作流的支撑。
• 添加对持久用户选定工作流名称的支持。
• 启用使用绝对路径上传文件和目录输入。
• 添加新的status命令以显示客户端的当前状态。
• 降低命令的详细程度，并改进错误消息。

0.1.0 (2018-01-30)

• 初始公开版本。