{ "info": { "author": "Jennifer Hamon", "author_email": "jen@hamon.io", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Topic :: Software Development :: Documentation" ], "description": "# Garnish: painless boilerplate licensing \n\n[![Build Status](https://travis-ci.org/jhamon/garnish.png?branch=master)](https://travis-ci.org/jhamon/garnish)\n\nA recent study found that [only 15% of github projects](http://www.theregister.co.uk/2013/04/18/github_licensing_study/) have\nclearly stated license terms. Omitting a license from your open source project limits its usefulness to the community.\n\nThis project aims to reduce the \"pain\" of applying boilerplate licensing to your\nopen source projects.\n\n### Install\n\nFor python devs, installing the latest release of garnish is as simple as \n\n $ pip install garnish\n\nIf you're not a frequent python user and don't have the `pip` installer, you can also install it manually \n\n $ git clone git://github.com/jhamon/garnish.git\n $ cd garnish\n $ python setup.py install\n\n### Quickstart \n\nTo see the full menu of available options and licenses, run `garnish -h` or\n`garnish --help` at any time. \n\nTo get started nagivate to your project root, and use the following syntax on the command line\n\n $ garnish \"Cool Copyright Hold\" \"Your Awesome Project Name\" \n\nA few examples of basic usage might be:\n\n $ garnish gpl3 \"GNU Foundation\" \"Emacs\" \n $ garnish mit \"Google, Inc\" \"Angular JS\"\n\nGarnish supports many popular and interesting licenses.\n\n Popular:\n artistic Perl Foudation Artistic License, Version 2.0\n agpl3 GNU Affero General Public License, Version 3.0\n apache2 Apache License, Version 2.0\n bsd3 BSD 3-Clause License\n bsd2 BSD 2-Clause License\n gpl2 GNU General Public License, Version 2.0\n gpl3 GNU General Public License, Version 3.0\n lgpl3 GNU Lesser General Public License,Version 3.0\n mit MIT License\n mpl2 Mozilla Public License, Version 2.0\n Other:\n crapl Community Research and Academic Programming License\n unlicense Release code to public domain. See unlicense.org.\n wtfpl Do What the Fuck You Want To Public License, Version 2\n\n\n### In-file copyright and licensing notices.\n\nGarnish can also add copyright and licensing notices at the beginning of your\nindividual source files; this is standard practice with some projects and some\nlicenses. When the terms of a license recommend or require a copyright and\nlicensing notice to be placed inside a file, garnish will do this automatically\nunless you prevent it using the `-x` option. You can force the use of source\nfile headers regardless of license used with the with the `-f` option.\n\nIf you find yourself needing to remove the licensing notice garnish has placed\ninside your project's source files (e.g. because you want to change to a\ndifferent license), run the `garnish-rm` (no space) command in your project\nroot. This command inspects each file and looks for the license block delimeters\nthat garnish normally applies (e.g. the `::::: LICENSE AND COPYRIGHT NOTICE ::::` \nand `::::::::::::::::::::::::::` lines). `garnish-rm` will do nothing to your\nfile if the notice delimeters are missing or modified.\n\n### License\n\nGarnish is Copyright (c) 2013 Jennifer Hamon (jen@hamon.io) and released under\nthe MIT license. For details about this license, please see the text of LICENSE. \n\n### Disclaimer\n\nAlthough this software has been tested, there is a chance that any files handled\nby the software could be lost or damaged. Consequently, **do not use garnish on\nwork that has not been commited to your repository.** As per the MIT License, I\nam not responsible for any data loss that may occur as a result of using this\ntool.\n\n### Contacting the author\n\nI am not a lawyer, and this software does not provide legal advice. However, if\nyou've found this software useful, I'd love to hear from you. Reach out on\ntwitter [@jenplusplus](http://www.twitter.com/jenplusplus) or email jen@hamon.io.\n\nTo report any issues or problems, please use the [github issue tracker](https://github.com/jhamon/garnish/issues).", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://www.github.com/jhamon/garnish", "keywords": "opensource gpl mit bsd licenses licensing", "license": "MIT License", "maintainer": null, "maintainer_email": null, "name": "garnish", "package_url": "https://pypi.org/project/garnish/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/garnish/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://www.github.com/jhamon/garnish" }, "release_url": "https://pypi.org/project/garnish/0.2.0/", "requires_dist": null, "requires_python": null, "summary": "Command-line tool for adding boilerplate licensing to your open-source projects. GPL, MIT, and BSD licenses supported.", "version": "0.2.0" }, "last_serial": 945150, "releases": { "0.2.0": [] }, "urls": [] }