Burocrata：检查并插入源代码中的版权和许可证声明

是Fatiando a Terra项目的一部分。

关于

Burocrata是一个小型的命令行程序，可以检查源代码文件中是否存在版权和许可证声明，并在缺失时添加它们。

安装

Burocrata可以从PyPI和conda-forge获取

python -m pip install burocrata

conda install burocrata -c conda-forge

使用

检查目录中每个.py文件是否包含许可证声明

$ burocrata --check --extension=py source_folder

移除--check选项将使Burocrata向没有许可证通知的文件添加许可证通知

$ burocrata --extension=py source_folder

许可证和版权通知可以在运行burocrata的目录中的pyproject.toml文件中进行配置

$ cat pyproject.toml
[tool.burocrata]
notice = '''
# Copyright (c) YYYY Name of Developer.
# Distributed under the terms of the BSD 3-Clause License.
# SPDX-License-Identifier: BSD-3-Clause'''

查看完整选项列表

$ burocrata --help

依赖项

我们使用以下依赖项（具体版本限制请参见pyproject.toml）：

• click 用于构建命令行界面。
• tomli 用于解析TOML配置文件。
• pathspec 用于解析.gitignore文件。

联系我们

了解如何联系我们的更多信息，请访问 fatiando.org/contact

贡献

行为准则

请注意，本项目采用行为准则发布。参与本项目即表示您同意遵守其条款。

贡献指南

请阅读我们的贡献指南，了解如何提供帮助和反馈。

许可证

Burocrata是免费和开源软件，在MIT许可证下分发。