reuse-tool

reuse是一个用于遵守REUSE建议的工具。

文档: https://reuse.readthedocs.io 和 https://reuse.software
源代码: https://github.com/fsfe/reuse-tool
PyPI: https://pypi.python.org/pypi/reuse
REUSE: 3.2
Python: 3.8+

背景

版权和许可很困难,特别是在重用来自不同项目的软件时,这些软件是在各种不同的许可下发布的。REUSE由自由软件欧洲基金会(FSFE)发起,提供了一套建议,以使您的自由软件项目更容易获得许可。这些建议不仅使您更容易声明您的作品的许可,而且还使计算机更容易理解您的项目是如何获得许可的。

简单概括一下,这些建议有三个方面:

选择和提供许可
向每个文件添加版权和许可信息
确认REUSE合规性

我们建议您阅读我们的教程,了解这三个步骤的详细指南。常见问题解答涵盖了关于许可、版权以及更复杂用例的基本问题。高级用户和集成商将发现完整规范很有帮助。

这个工具的存在就是为了使开发人员更容易遵守上述建议。

有其他工具具有更多功能,可分析和检查软件项目中的版权和许可。REUSE助手工具,另一方面,仅被设计为一个简单的工具,以协助遵守REUSE建议。

安装

通过包管理器安装(推荐)

许多操作系统上都有可用的软件包。欢迎您帮助我们为更多发行版打包这个工具!

自动生成的列表可以在repology.org找到,但不保证完整性。

通过pipx安装和运行(推荐)

以下一行代码既可在PyPI上通过pipx安装又可运行该工具:

pipx run reuse lint

pipx会自动将reuse隔离到自己的Python虚拟环境中,这意味着它不会干扰其他Python包,其他Python包也不会干扰它。

如果您想在不每次都加上pipx run的情况下使用reuse,请按以下方式全局安装:

pipx install reuse

然后reuse将可在~/.local/bin中使用,您必须将其添加到$PATH中。

确保~/.local/bin在您的$PATH中。在Windows上,您的环境所需的路径可能类似于%USERPROFILE%\AppData\Roaming\Python\Python39\Scripts,具体取决于您安装的Python版本。

要升级reuse,运行以下命令:

pipx upgrade reuse

为了获得完整的功能,建议使用以下软件:

Git
Mercurial 4.3+
Pijul
Jujutsu

通过pip安装

要将reuse安装到~/.local/bin,运行:

pip3 install --user reuse

之后,请确保~/.local/bin如前一节所述添加到您的$PATH中。

要升级reuse,运行以下命令:

pip3 install --user --upgrade reuse

从源代码安装

您也可以从源代码安装这个工具,但我们建议使用上述方法,因为那样更容易和更稳定地进行更新。请确保您的机器满足通过pip进行安装所需的要求。

pip install .

使用

首先,请阅读REUSE教程。简而言之:

将您的许可证放置在 LICENSES/ 目录中。
为每个文件添加一个注释头,内容为 SPDX-License-Identifier: GPL-3.0-or-later 和 SPDX-FileCopyrightText: $YEAR $NAME。您可以灵活地调整格式,只需确保该行以 SPDX-FileCopyrightText: 开头。
使用此工具验证您的工作。

标题示例:

# SPDX-FileCopyrightText: 2017 Free Software Foundation Europe e.V. <https://fsfe.org>
#
# SPDX-License-Identifier: CC-BY-SA-4.0

CLI

要检查是否符合建议,请使用 reuse lint:

~/Projects/reuse-tool $ reuse lint
[...]

恭喜您! 您的项目符合 REUSE 规范 3.2 版的要求 :-)

此工具还可以执行更多操作,详见文档。以下是简短概括:

annotate - 在文件头部添加版权和/或许可信息。
download - 将指定的许可证下载到 LICENSES/ 目录中。
init - 设置项目以符合 REUSE 合规性。
lint - 验证项目是否符合 REUSE 合规性。
spdx - 生成项目中所有文件的 SPDX 文档。
supported-licenses - 打印 REUSE 支持的所有许可证。

示例演示

在此视频中,我们将按照教程使 REUSE 示例存储库符合要求。

一些基本的 REUSE 工具命令演示

在 Docker 中运行

fsfe/reuse Docker 镜像可从 Docker Hub 获得。使用它,您可以轻松地将 REUSE 纳入 CI/CD 流程中。这样,您可以在每次构建中检查 REUSE 合规性。在我们的面向开发者的资源中,您可以了解如何在 Drone、Travis、GitHub 或 GitLab CI 中集成 REUSE 工具。

您可以通过提供要运行的命令(例如 lint、spdx)来运行助手工具。该镜像的工作目录默认为 /data。因此,如果您要检查当前工作目录中的项目,可以将其挂载到容器的 /data 目录上,并告诉该工具进行检查。它看起来大致像这样:

docker run --rm --volume $(pwd):/data fsfe/reuse lint

您也可以提供其他参数,像这样:

docker run --rm --volume $(pwd):/data fsfe/reuse --include-submodules spdx -o out.spdx

可用的标签有:

latest - reuse 的最新版本。
{major} - 最新主版本。
{major}.{minor} - 最新次版本。
{major}.{minor}.{patch} - 特定版本。

您可以为任何标签添加 -debian,以获得基于 Debian 的镜像,而不是基于 Alpine 的镜像,后者体积更大,但可能更适合于许可合规性。

作为 pre-commit hook 运行

您可以将 reuse lint 自动运行在每次提交时作为 Git 的 pre-commit hook。这使用了 pre-commit。一旦安装完毕,将以下内容添加到存储库中的 .pre-commit-config.yaml:

repos:
  - repo: https://github.com/fsfe/reuse-tool
    rev: v3.0.2
    hooks:
      - id: reuse

然后运行 pre-commit install。现在,每次提交时,都会在后台运行 reuse lint,如果出现错误,它将阻止您的提交。

维护者

Carmen Bianca Bakker carmenbianca@fsfe.org

前任维护者

Max Mehl max.mehl@fsfe.org
Linus Sehn linus@fsfe.org

贡献

如果您有兴趣为 reuse 项目做贡献,有几种方式可以参与。项目的开发在 GitHub 上进行,网址为 https://github.com/fsfe/reuse-tool。在那里,您可以提交错误报告、功能请求和拉取请求。即使您有疑问,也欢迎您随时开一个新的 issue。欢迎各种类型的贡献,开发团队很乐意为新贡献者提供指导和支持。

在开启拉取请求以作出更改时,请务必谨慎,因为这些更改可能尚未得到团队的认可。这样的拉取请求可能会被关闭,从而造成失望。为了避免这种情况,请首先开一个 issue。

此外,reuse@lists.fsfe.org 邮件列表可用于与项目相关的讨论和支持。

您可以在 https://reuse.readthedocs.io/en/latest/contribute.html 找到完整的贡献指南。