AboutCode-toolkit是一种使用小型文本文件记录第三方软件来源（来源和许可证）的工具。收集清单并生成归属文档。
项目描述
简介
AboutCode Toolkit 和 ABOUT 文件提供了一种简单的方法来记录项目中使用的第三方软件组件的来源、许可证、使用和其他重要或有趣的信息。
您首先将 ABOUT 文件（一种包含字段/值对的简单 YAML 格式文本文件）与您使用的每个第三方软件组件并排放置。每个 ABOUT 文件记录了一个软件的来源和许可证。整个存储库的 testdata/ 目录中有许多 ABOUT 文件的示例（有效或无效）。
AboutCode Toolkit 的当前版本可以读取这些 ABOUT 文件，以便您可以收集和验证您使用的第三方组件清单。
此外，该工具还能够生成归属声明并识别项目中使用的可重新分发的源代码，以帮助您遵守开源许可证的条件。
AboutCode Toolkit 的此版本遵循关于代码规范版本 3.3.2，请参阅：https://aboutcode-toolkit.readthedocs.io/en/latest/specification.html
构建和测试状态
分支 |
Linux/macOS |
Windows |
|---|---|---|
主分支 |
||
开发分支 |
需求
AboutCode Toolkit 仅在 Linux、Mac 和 Windows 上与 Python 3.7 或更高版本进行测试。如果您尚未安装 Python 解释器，则需要安装一个。
在 Linux 和 Mac 上，Python 通常默认安装。要验证可能预安装的版本，请打开终端并输入
python –version
注意
Debian 已经决定 distutils 不是一个核心 Python 包，因此它不包括在 Debian 和基于 Debian 的操作系统的新版本中。一种解决方案是运行： sudo apt install python3-distutils
- 在 Windows 或 Mac 上，您可以在此处下载最新的 Python
下载 Windows 的 .msi 安装程序或 Mac 的 .dmg 归档文件。打开并使用所有默认选项运行安装程序。
安装
- 从
- 检出或下载并提取 AboutCode Toolkit，然后在 POSIX 系统上运行
./configure
- 或者在 Windows 上
configure
激活 VIRTUALENV
- 要激活虚拟环境，请在 POSIX 系统上运行
source venv/bin/activate
- 或者在 Windows 上
venv\bin\activate
取消 VIRTUALENV 激活
- 要取消虚拟环境激活，请在 POSIX 和 Windows 系统上运行
deactivate
版本架构
从 AboutCode 版本 4.0.0 开始，AboutCode Toolkit 将遵循 SemVer 版本架构。
- 即 MAJOR.MINOR.PATCH 格式
MAJOR 版本在创建不兼容的 API 变更时使用，
MINOR 版本在向后兼容的方式添加功能时使用，
PATCH 版本在向后兼容的修复错误时使用。
参考
有关文档，请参阅 https://aboutcode-toolkit.readthedocs.io/en/latest/
有关参考，请参阅 https://aboutcode-toolkit.readthedocs.io/en/latest/reference.html
测试和开发
- 要安装所有开发依赖项，请在 POSIX 系统上运行
./configure –dev
- 或者在 Windows 上
configure –dev
- 要验证一切正常工作，您可以使用以下命令运行测试套件
pytest
清理构建和安装的文件
- 为了清理已构建和安装的文件，请在posix系统上运行：
./configure –clean
- 或者在 Windows 上
configure –clean
帮助和支持
如果您有任何问题或发现错误，请在此处提交工单：
对于问题，您可以使用：
源代码
- AboutCode Toolkit可通过GitHub获取。要获取最新版本，请访问：
黑客
我们接受与此工具同一许可证下的拉取请求。您同意http://developercertificate.org/
许可证
AboutCode Toolkit在Apache 2.0许可证下发布。有关详细信息，请参阅（当然）about.ABOUT文件。
下载文件
下载适用于您的平台文件。如果您不确定选择哪个，请了解有关安装包的更多信息。
