dependency-metrics 0.1.1

欢迎使用dependency-metrics

摘要

这是一个命令行工具，用于分析和监控项目的依赖项是否是最新的。有关详细信息，请参阅下面的使用方法部分。

支持的包管理器

• pip
• yarn

支持的应用程序监控平台

• DataDog

使用方法

在您希望生成度量的仓库中运行metrics工具。

默认行为

您需要的只是一个您想要生成度量的包管理器，然后metrics将输出一个表格，详细说明每个依赖项有多过时。

$ metrics pip
Behind   Package                      Latest       Version
0.1.0    my-depedency                 1.1.0        1.0.0
2.0.0    my-other-dependency          3.2.1        1.2.3

--stats选项

使用--stats选项来生成一个简单的字典，显示过时依赖项的总数，以及详细说明每个版本类型过时依赖项数量的拆分。

$ metrics pip --stats
Total: 5
Outdated: 2
Multi-Major: 1
Major: 0
Minor: 1
Patch: 0
Unknown: 0

--send选项

注意：要成功将统计信息发布到受支持的后端，需要额外的设置。有关更多信息，请参阅平台设置。

使用--send选项将--stats生成的相同度量信息发布到应用程序监控平台。

$ metrics pip --send

应用程序监控平台设置

这是使用--send选项的必要条件，使您能够将生成的统计信息发送到您选择的任何后端。

DataDog

在您运行 metrics <package_manager> --send 的环境中设置 DATADOG_API_KEY 和 DATADOG_APP_KEY 环境变量。

开发

需求

pip install -e .  # installs dependencies defined in pyproject.toml
pip install -e .[test]  # installs test dependencies -- '.[test]' if using zsh

测试

必须首先安装测试依赖项。参见上面的 需求。

nose2  # runs all tests
nose2 dot.path.to.file.class.or.test  # runs specific test