PDS Lasso Reports

PDS Lasso Reports 软件包提供生成各种类型报告的工具。它提供了以下三个命令

• git-ping 通过向分支提交空提交并推送来“ping”该分支
• summaries 生成各种格式的构建摘要表
• pds-plan 创建规划板报告

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

这可能对开发人员和最终用户都有用。

先决条件

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

用户快速入门

安装方法

pip install lasso-reports

要执行，请运行

(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