Metadata-Version: 2.4
Name: licen
Version: 0.2.2
Summary: generate the license for you
Home-page: http://github.com/lord63/licen
Author: lord63
Author-email: lord63.j@gmail.com
License: MIT
Keywords: license generate cli
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
License-File: LICENSE
Requires-Dist: docopt==0.6.2
Requires-Dist: jinja2>=3.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Licen
[![Latest Version][1]][2]

Generate your license. Yet another [lice][5], but implemented with Jinja2 and
docopt, should be much more elegant and cleaner. I also get many inspirations
from [joe][6](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][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.


[1]: http://img.shields.io/pypi/v/licen.svg
[2]: https://pypi.python.org/pypi/licen
[5]: https://github.com/licenses/lice
[6]: https://github.com/karan/joe
[guide]: https://help.github.com/articles/set-up-git/
[gif]: https://github.com/lord63/licen/blob/master/licen_demo.gif
[here]: https://github.com/licenses/lice/issues/44
[issue#1]: https://github.com/lord63/licen/issues/1
[issue#2]: https://github.com/lord63/licen/issues/2
