PDS Lasso需求

PDS Lasso需求根据GitHub问题生成软件项目的需求报告。它是“Lasso”产品系列的一部分。

请访问我们的网站： https://nasa-pds.github.io/lasso-requirements

这可能对开发人员和最终用户有有用的信息。

先决条件

安装此软件需要在目标系统上存在git。

用户快速入门

使用以下方式安装

pip install lasso-requirements

执行时，运行

(put your run commands here)

行为准则

所有NASA-PDS软件的用户和开发者都应遵守我们的行为准则。请阅读此准则以确保您了解我们社区的要求。

开发

要开发此项目，请使用您最喜欢的文本编辑器，或具有Python支持的集成开发环境，例如PyCharm。

贡献

有关如何为NASA-PDS代码库做出贡献的信息，请参阅我们的贡献指南。

安装

在您的虚拟环境中以可编辑模式安装，并添加额外的开发依赖项

pip install --editable '.[dev]'

配置pre-commit钩子

pre-commit install
pre-commit install -t pre-push
pre-commit install -t prepare-commit-msg
pre-commit install -t commit-msg

这些钩子检查代码格式，并阻止包含如密码或API密钥等机密信息的提交。但是，您需要在全局Git配置中完成一次设置。请参阅Git机密性条目了解如何操作。

打包

为了隔离并能够重新生成此包的环境，您应使用Python虚拟环境。要这样做，请运行

python3 -m venv venv

然后仅使用venv/bin/python、venv/bin/pip等。或者，“激活”虚拟环境，通过在venv/bin目录中源适当的脚本。

如果您已安装tox并希望它为您创建环境并安装依赖项，请运行

tox --devenv <name you'd like for env> -e dev

开发依赖项在setup.cfg中指定为dev extras_require；它们将按以下方式安装到虚拟环境中

pip install --editable '.[dev]'

所有源代码都位于src目录下的子目录中。

工具

模板仓库中包含的dev extras_require安装了black、flake8（附带一些插件）和mypy，并为所有这些提供了默认配置。您可以使用以下方式运行所有这些（以及更多！）

tox -e lint