dbio-cli 1.5.5

安装

pip安装dbio-cli.

用法

readthedocs.io上的文档

• CLI文档

• Python API文档

要查看您可以使用的命令列表，请键入dbio --help。

开发

要在CLI上进行开发，首先运行pip install -r requirements-dev.txt。您可以通过在存储库根目录中运行make install来安装您的本地修改后的dbio包副本。

要使用带有本地或测试DSS的命令行界面，首先运行dbio（如果您想从存储库根目录中使用包，请运行scripts/dbio）。这将创建文件~/.config/dbio/config.json，您可以修改它以更新DSSClient.swagger_url的值，使其指向您的DSS部署提供的Swagger定义的URL。最后，CLI强制HTTPS连接到DSS API。如果您正在连接到本地DSS，请在此处更改dbio/util/__init__.py中的SwaggerClient对象

scheme = "http"

要使用Python界面与本地或测试DSS一起使用，通过swagger_url参数将Swagger定义的URL传递给DSSClient构造函数

client = DSSClient(swagger_url="https://dss.example.com/v1/swagger.json")

您还可以使用环境变量DBIO_CONFIG_FILE在默认的config.json上叠加一个最小配置文件，例如

export SWAGGER_URL="https://dss.dev.ucsc-cgp-redwood.org/v1/swagger.json"
jq -n .DSSClient.swagger_url=env.SWAGGER_URL > ~/.config/dbio/config.staging.json
export DBIO_CONFIG_FILE=~/.config/dbio/config.staging.json

测试

在运行测试之前，首先运行dbio dss login。这将在浏览器中打开一个页面，您可以在其中登录以使用Google进行身份验证。请使用白名单域名（在此处的DSS_SUBSCRIPTION_AUTHORIZED_DOMAINS_ARRAY中）中的一个电子邮件地址。

然后运行make test。

主要CI测试是通过Gitlab toilspark实例上的Travis CI进行的。

安全策略

请将您发现的任何安全相关问题的报告发送至team-redwood-group@ucsc.edu。请使用描述性的主题行发送报告电子邮件。此外，请随报告包含以下信息

• 您的姓名和所属机构（如有）。

• 对漏洞技术细节的描述，以帮助我们重现您的发现。

• 解释谁可以利用此漏洞，以及他们这样做时所获得的好处（攻击场景）。

• 此漏洞是否公开或为第三方所知。如果是，请提供详细信息。

许可协议

在MIT 许可协议下授权。