/licen

Generate your license. Yet another lice, but implement with Jinja2 and docopt.

Primary LanguageGroffMIT LicenseMIT

Licen

Latest Version Build Status

Generate your license. Yet another lice, but implemented with Jinja2 and docopt, should be much more elegant and cleaner. I also get many inspirations from joe(help you generate gitignore).

Why and what's the difference

seems better than lice:

  • Licen use Jinja2 as its template engine, sweet and easy. Lice do it by hand.
  • Licen use docopt for the command line interface. Lice use argparse.
  • Licen don't render the boilerplate in the license template. Lice do. Check out the issue here.
  • Licen is pep8 checked. Lice don't.

seems not good as lice:

  • Licen support less licenses. Check issue#1
  • Licen haven't support comment the license header yet. Check issue#2

Install

$ pip install licen

Usage

NOTE: because licen use the git configuration(user.name and user.email) as default context, please make sure that you've set up git properly. You can check this guide if you have done yet.

A gif is worth than a thousand words.

demo_gif

In short, generate a licnese:

$ licen mit > LICENSE

Generate a header:

$ licen header gpl-2.0-header > main.py

Or get detailed help message from the terminal.

$ licen -h
licen, generates license for you via command line

Usage:
  licen [header] (-l | --list)
  licen [-y YEAR] [-f FULLNAME] [-e EMAIL] LICENSE_NAME
  licen header [-y YEAR] [-f FULLNAME] [-e EMAIL] LICENSE_HEADER
  licen --var NAME
  licen (-h | --help)
  licen (-V | --version)

Options:
  -l --list     List all the support licenses or headers.
  -y YEAR       Specify the year.
  -f FULLNAME   Specify the owner's fullname.
  -e EMAIL      Specify the email.
  --var         List all the variables in the template.
  -h --help     Show the help message.
  -V --version  Show the version info.

License

MIT.