在源代码文件中添加或替换许可证模板。
copyright的Python项目详细描述
概述
在源代码文件中添加或替换许可证/版权模板。
所有相邻的注释块(以空行或代码行为界) 在注入新的 信息。
在运行此程序之前,应将所有代码提交到repo中 并使用diff实用程序检查结果。
功能
- 从扩展名或shebang或header自动检测语言。
- 如果无法自动检测到文件,则强制使用编程语言。
- 指定要处理的文件列表。
- 从当前或特定路径进行递归或非递归处理。
- 可从json文件加载的自定义模板。
- 指定作者、年份、程序和简短描述。
- 包含或排除带有通配符或正则表达式的文件或目录。
- 附加到文件或在任何连续的头注释块后插入。
- 控制左侧边距填充和换行间距。
- 重复或自动使用的JSON配置文件摄取,被重写 通过命令行选项。
- 多行或单行注释样式,例如/**/vs.//。
- 安静模式以禁止打印更改的文件。
- 目前支持的语言:C/C++、Java、HTML、 shell/bash/csh/ksh/tcsh/zsh、perl、python、sql、xml
- Python2和3。
示例
递归处理当前目录并自动检测文件。
$ copyright -c config.json
处理与通配符匹配的文件,追加到文件末尾。
$ copyright -a 'Joe Smith' -p MyApp -l mit -i '*.py,foo*.h,script?' --back
使用自定义模板。
$ copyright -c config.json -t my_templates.json --license my-license-2.0
安装
和皮皮在一起。
$ pip install copyright
用柏油球。
$ python setup.py install
测试
$ make test
常见问题解答
第一季度。如何在一个文件中保存多个许可证?A1号。一个策略是 创建一个自定义模板文件,将所有许可合并为一个 键/值对,然后处理特定的文件列表。
新闻
1.0.1.0
- 增加了-q/–安静模式。
- 修正了-v/-version消息。
1.0.0.0
- 初次发布。
许可证
版权所有(c)2016 Remik Zimlinski
这个计划绝对没有保证。这是免费软件, 欢迎您在GPLv3的条件下重新分配它 执照。