Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/architv/harvey
:information_desk_person: Harvey is a command line legal expert who manages license for your open source project.
https://github.com/architv/harvey
Last synced: 6 days ago
JSON representation
:information_desk_person: Harvey is a command line legal expert who manages license for your open source project.
- Host: GitHub
- URL: https://github.com/architv/harvey
- Owner: architv
- License: mit
- Created: 2015-10-10T08:35:50.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-07T16:48:28.000Z (over 6 years ago)
- Last Synced: 2025-01-13T01:06:44.320Z (13 days ago)
- Language: Python
- Homepage:
- Size: 272 KB
- Stars: 291
- Watchers: 7
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-starred - harvey - :information_desk_person: Harvey is a command line legal expert who manages license for your open source project. (Python)
- starred-awesome - harvey - :information_desk_person: Harvey is a command line legal expert who manages license for your open source project. (Python)
README
harvey
=====
[](https://badge.fury.io/py/harvey)
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`](https://github.com/architv/harvey#list-of-supported-licenses)
- Works on Mac, Linux, Windows
## Installation
### Option 1: [Pip](https://pypi.python.org/pypi/harvey)
```bash
$ pip install harvey
```
### Option 2: From source
```bash
$ git clone [email protected]:architv/harvey.git
$ cd harvey/
$ python setup.py install
```
####Note:
Windows users might need to install [ansicon](https://github.com/adoxa/ansicon) for colorama to work correctly.
## Usage
### Get summary, can, cannot and must rules for a license
```bash
$ harvey gpl-2.0 --tldr
```
### Get a `LICENSE` for your git repo
```bash
$ harvey mit # outputs mit license to stdout
```
### Overwrite existing `LICENSE`
```bash
$ harvey mit > LICENSE # saves a new mit LICENSE file
```
OR
```bash
$ harvey --export mit # saves a new mit LICENSE file
```
### List all licenses
```bash
$ harvey ls # or `harvey list`
```
### Help
```bash
$ 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
#### How is this any better than [choose a license](http://choosealicense.com/licenses/) and [tldr legal](https://tldrlegal.com/)?
* Harvey doesn't only let you select a license, it also helps you to add it to your project. So, doing something like:
```bash
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](http://choosealicense.com/licenses/) 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](https://github.com/architv/harvey/issues) to report any bugs or file feature requests.
#### Developing
PRs are welcome. To begin developing, do this:
```bash
# make virtual env
$ git clone [email protected]:architv/harvey.git
$ pip install requirements.txt
$ cd harvey/
$ python harvey/harvey.py mit
```
Licence
====
Open sourced under [MIT License](LICENSE) (Created by harvey)
Image: [buylocalexperts.com](http://www.buylocalexperts.com/sanantonio/images/stories/buy-local-legal-expert.png)