用于向开放源代码项目添加样板许可的命令行工具。支持GPL、MIT和BSD许可证。
garnish的Python项目详细描述
#配饰:无痛样板许可
[![生成状态](https://travis-ci.org/jhamon/garnish.png?branch=master)](https://travis-ci.org/jhamon/garnish)
最近的一项研究发现,[只有15%的github项目](http://www.theregister.co.uk/2013/04/18/github_licensing_study/)有 明确规定的许可条款。从开源项目中省略许可证会限制其对社区的有用性。
此项目旨在减少将样板许可证应用于 开源项目。
###安装
对于python开发人员来说,安装最新版本的garnish非常简单
$ pip install garnish
如果您不是经常使用python的用户,并且没有pip安装程序,那么您也可以手动安装它。
$ git clone git://github.com/jhamon/garnish.git $ cd garnish $ python setup.py install
###快速启动
要查看可用选项和许可证的完整菜单,请运行garnish-h或 随时装饰-帮助。
要开始对项目根目录进行nagivate操作,请在命令行上使用以下语法
$ garnish <license> “Cool Copyright Hold” “Your Awesome Project Name”
一些基本用法示例可能是:
$ garnish gpl3 “GNU Foundation” “Emacs” $ garnish mit “Google, Inc” “Angular JS”
Garnish支持许多流行和有趣的许可证。
- Popular:
- artistic Perl Foudation Artistic License, Version 2.0 agpl3 GNU Affero General Public License, Version 3.0 apache2 Apache License, Version 2.0 bsd3 BSD 3-Clause License bsd2 BSD 2-Clause License gpl2 GNU General Public License, Version 2.0 gpl3 GNU General Public License, Version 3.0 lgpl3 GNU Lesser General Public License,Version 3.0 mit MIT License mpl2 Mozilla Public License, Version 2.0
- Other:
- crapl Community Research and Academic Programming License unlicense Release code to public domain. See unlicense.org. wtfpl Do What the Fuck You Want To Public License, Version 2
###文件中的版权和许可声明。
装饰也可以在您的 单独的源文件;这是一些项目和一些 许可证。当许可条款建议或要求版权和 将许可通知放在文件中,Garnish将自动执行此操作 除非您使用-x选项阻止它。你可以强制使用源 文件头,而不考虑与-f选项一起使用的许可证。
如果您发现您需要删除Garnish放置的许可通知 在项目的源文件中(例如,因为要更改为 不同的许可证),在项目中运行garnish rm(没有空格)命令 根。此命令检查每个文件并查找许可证块分隔符 通常情况下,该条款适用(例如,许可证和版权声明:::::::: 以及:::::::::::::::::::::::::::::行。装饰房间对您的 文件,如果通知Delimeters丢失或修改。
###许可证
配饰版权所有(c)2013珍妮弗哈蒙(jen@hamon.io),发布于 麻省理工学院的执照。有关此许可证的详细信息,请参阅许可证文本。
###免责声明
虽然这个软件已经过测试,但是有可能处理任何文件 软件可能会丢失或损坏。因此,不在 尚未提交给存储库的工作。根据麻省理工学院的许可证,我 我不负责任何数据丢失,可能会由于使用此 工具。
###联系作者
我不是律师,这个软件不提供法律咨询。但是,如果 你觉得这个软件很有用,我很想听听你的意见。伸出手来 twitter[@jenplusplus](http://www.twitter.com/jenplusplus)或电子邮件jen@hamon.io。
要报告任何问题,请使用[github问题跟踪器](https://github.com/jhamon/garnish/issues)。