Skip to main content

Sensible repository licensing for Humans

Project description

lisense
=======

Sensible repository licensing for Humans

.. image:: https://pypip.in/status/lisense/badge.svg
:target: https://pypi.python.org/pypi//
:alt: Development Status

.. image:: https://pypip.in/version/lisense/badge.svg
:target: https://pypi.python.org/pypi//
:alt: Latest Version

.. image:: https://pypip.in/py_versions/lisense/badge.svg
:target: https://pypi.python.org/pypi//
:alt: Supported Python versions

.. image:: https://pypip.in/license/lisense/badge.svg
:target: https://pypi.python.org/pypi//
:alt: License

.. image:: https://pypip.in/download/lisense/badge.svg
:target: https://pypi.python.org/pypi///
:alt: Downloads

**Sir Isaac Newton once said that**
*Open source simply isn't open source without a proper license. So add a license. Always.*

GitHub recently launched their `License API <https://developer.github.com/v3/licenses/>`__, it's still in preview stage though.
They also released a blog post showing `Open source license usage on GitHub.com <https://github.com/blog/1964-open-source-license-usage-on-github-com>`__, which is enough to convice you that why adding a license is
`sine qua non <http://lmgtfy.com/?q=define+sine+qua+non>`__.


*Newton and Open Source, Respect both, let us.*

\- Yoda

lisense in action
~~~~~~~~~~~~~~~~~
.. figure:: https://raw.githubusercontent.com/pravj/lisense/master/docs/lisense.gif
:alt: lisense


lisense. What?
~~~~~~~~~~~~~~
lisense is a command-line tool which helps you license your projects.
- Lets you have a global configuration. Use your defaults, anywhere, anytime.
- Guides you about using a particular license, better than you uncle.
- And yes! Generates licenses.

lisense. Controls?
~~~~~~~~~~~~~~~~~~
Generating a license is more easy than doing nothing.
- lisense list
List all available licenses.
- lisense guide [license]
Provide guidance about a license. Description, use cases etc.
- lisense setup
Setup global lisense configurations. Default license and owner name.
- lisense new [license] --owner="OWNER NAME"
Generates new license. Both the *license* and *owner* arguments are optional. Uses defaults when not supplied.

Automatic extra context variable handling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Almost all the licenses have two common fields in them, *owner* and *year*. Some of them have extra fields also. For example, the GPL-v2 license
has a field *description*, which asks for the description of the project.

Lisense uses *jinja2*'s low level meta API to parse the abstract syntax tree of the template and interactively asks users to fill
extra fields, if any.

So, you don't have to worry about it.

Dependencies
~~~~~~~~~~~~
- `docopt <https://github.com/docopt/docopt>`__ - command-line argument parsing
- `jinja2 <https://github.com/mitsuhiko/jinja2>`__ - generate licenses from license templates
- `xtermcolor <https://github.com/broadinstitute/xtermcolor>`__ - colorful messages on terminal

-----

Built with :two_hearts: by `Pravendra Singh <http://pravj.github.io>`__

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lisense-1.1.0.tar.gz (65.1 kB view details)

Uploaded Source

File details

Details for the file lisense-1.1.0.tar.gz.

File metadata

  • Download URL: lisense-1.1.0.tar.gz
  • Upload date:
  • Size: 65.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for lisense-1.1.0.tar.gz
Algorithm Hash digest
SHA256 61e05abb770fde3836682941c47543bf46a01d6af8c91105fa16924ae9ddc04b
MD5 b82ade44c5b6cf953988f96f3215e704
BLAKE2b-256 f83cb14b0a22147a119ce430a7909470086798839ef362a8f1258b777351f7b8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page