har

harvey

πŸ’β€β™€οΈ Harvey is a command line legal expert who manages license for your open source project.

Showing:

Popularity

Downloads/wk

0

GitHub Stars

292

Maintenance

Last Commit

6yrs ago

Contributors

5

Package

Dependencies

3

License

MIT

Categories

Readme

harvey

PyPI version

Harvey is a command line legal expert who manages license for your open source project.

Demo

Features

  • Written in Python
  • Supports all Github-supported licenses
  • Works on Mac, Linux, Windows

Installation

Option 1: Pip

$ pip install harvey

Option 2: From source

$ git clone git@github.com:architv/harvey.git
$ cd harvey/
$ python setup.py install

####Note:

Windows users might need to install ansicon for colorama to work correctly.

Usage

Get summary, can, cannot and must rules for a license

$ harvey gpl-2.0 --tldr 

Get a LICENSE for your git repo

$ harvey mit    # outputs mit license to stdout

Overwrite existing LICENSE

$ harvey mit > LICENSE   # saves a new mit LICENSE file

OR

$ harvey --export mit   # saves a new mit LICENSE file

List all licenses

$ harvey ls    # or `harvey list`

Help

$ harvey --help

List of supported licenses

  • BSD 3-clause "New" or "Revised" License [bsd-3-clause]
  • GNU Lesser General Public License v3.0 [lgpl-3.0]
  • GNU General Public License v2.0 [gpl-2.0]
  • Mozilla Public License 2.0 [mpl-2.0]
  • GNU General Public License v3.0 [gpl-3.0]
  • The Unlicense [unlicense]
  • Creative Commons Zero v1.0 Universal [cc0-1.0]
  • Artistic License 2.0 [artistic-2.0]
  • GNU Affero General Public License v3.0 [agpl-3.0]
  • ISC License [isc]
  • GNU Lesser General Public License v2.1 [lgpl-2.1]
  • Eclipse Public License 1.0 [epl-1.0]
  • Apache License 2.0 [apache-2.0]
  • BSD 2-clause "Simplified" License [bsd-2-clause]
  • MIT License [mit]

FAQ's

  • Harvey doesn't only let you select a license, it also helps you to add it to your project. So, doing something like:
harvey apache-2.0 > LICENSE

will add the apache license in your project, with your user name, which you have setup in your git config settings

  • Yes, choose a license also allows you to select a license. But since this is a CLI app, you can choose the license without breaking your workflow. Thus, it saves you time by not having to switch over to the browser.

Still, it seems really unnecessary.

Apart from what I have mentioned above, I wouldn't go as far as saying that harvey is absolutely essential to manage license for your open source project. I felt the need for the app because every time I had to add a license to my project I had to head over to the browser for a license template. So, I created harvey to allow me to add a license without breaking my workflow.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

PRs are welcome. To begin developing, do this:

# make virtual env
$ git clone git@github.com:architv/harvey.git
$ pip install requirements.txt
$ cd harvey/
$ python harvey/harvey.py mit

Licence

Open sourced under MIT License (Created by harvey)

Image: buylocalexperts.com

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100