Lucy

A CLI tool to generate license file for your project.

Features

• Written in simple Python
• Easy to install
• Easy to use
• Uses Github v3 API to create your license file.

Python libraries used

• Click
• requests

Installation

Option 1: via Pip

$ pip install lucy

Option 2: From source

$ git clone --recursive git@github.com:pattu777/Lucy.git
$ cd Lucy/
$ python setup.py install

Usage

List all available licenses

$ lucy list

Output:

mit
mpl-2.0
gpl-3.0
lgpl-3.0
unlicense
bsd-2-clause
isc
lgpl-2.1
gpl-2.0
apache-2.0
cc0-1.0
artistic-2.0
bsd-3-clause
agpl-3.0
epl-1.0

Generate a new license.

$ lucy create <License Name> --name=<Author Name>             
$ lucy create mit --name=Chinmaya                     # Creates a MIT license for your project.

Contributing

Bug Reports & Feature Requests

Report any bugs through the issue tracker.

Developing

Create a new branch and send a pull request. To begin developing, do this:

# Create a virtual environment
$ git clone --recursive git@github.com:pattu777/Lucy.git
$ cd Lucy
$ virtualenv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
$ git checkout -b <feature-branch-name>
$ python lucy/lucy.py list