Notary: License your project
============================

.. image:: https://img.shields.io/pypi/v/notary.svg
   :target: https://pypi.python.org/pypi/notary

.. image:: https://img.shields.io/pypi/l/notary.svg
    :target: https://pypi.python.org/pypi/notary

.. image:: https://img.shields.io/pypi/wheel/notary.svg
    :target: https://pypi.python.org/pypi/notary

.. image:: https://img.shields.io/pypi/pyversions/notary.svg
    :target: https://pypi.python.org/pypi/notary

.. image:: https://travis-ci.org/sxn/notary.svg?branch=master
    :target: https://travis-ci.org/sxn/notary

.. image:: https://codecov.io/gh/sxn/notary/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/sxn/notary

.. image:: https://dependencyci.com/github/sxn/notary/badge
    :target: https://dependencyci.com/github/sxn/notary

.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
    :target: https://saythanks.io/to/sorin


-----------------------------

**Notary** is a Python CLI tool that allows you to manage your project's license.
any license from `Choose a License <https://choosealicense.com/>`_ and add it to your project.

.. image:: https://asciinema.org/a/105819.png
   :target: https://asciinema.org/a/105819?autoplay=1

Installation
------------

::

    pip install notary

Usage
-----

::

    $ notary
    Usage: notary [OPTIONS] COMMAND [ARGS]...

    Manages your project's license.

    Options:
    -h, --help  Show this message and exit.

    Commands:
    add     Adds a license, replacing any that might exist.
    remove  Removes any license present in the current folder.

::

    $ notary add --help
    Usage: notary add [OPTIONS]

    Tries to find a license that matches the given LICENSE argument. If one
    exists and takes a author and year, it adds them to the license. Otherwise
    it writes the license without an author and year and informs the user.

    :param license_name: the 'human' name of the license that should be added.
    Notary will try to guess the actual name from this. :param author: Tuple
    representing the name of the author. :param year: Integer representing the
    year that will be written to the license.

    Options:
    -l, --license TEXT  The name of the license you want to add. Doesn't have to
                        be exact.
    -a, --author TEXT   The name that will be on the license. Is ignored if not
                        required.
    -y, --year INTEGER  The year that will be on the license. Is ignored if not
                        required.  [default: 2017]
    -h, --help          Show this message and exit.

::

    $ notary add
    License name: m
    The following license file(s) already exist:
    /Users/sorin/Workspace/notary/LICENSE
    Remove /Users/sorin/Workspace/notary/LICENSE? [y/N]: y
    Removed /Users/sorin/Workspace/notary/LICENSE.
    Found the following matching licenses:
    1: MIT License
    2: Mozilla Public License Version 2.0
    Please choose which one you'd like to add [1]: 1
    Author: Sorin Muntean
    Adding MIT License as the project's license. Continue? [y/N]: y
    Added MIT License to /Users/sorin/Workspace/notary/LICENSE

::

    $ notary add --author 'Sorin Muntean'
    License name: mit
    Adding MIT License as the project's license. Continue? [y/N]: y
    Added MIT License to /Users/sorin/Workspace/notary/LICENSE

::

    $ notary add -l mit -a 'Sorin Muntean' -y 2017
    Adding MIT License as the project's license. Continue? [y/N]: y
    Added MIT License to /Users/sorin/Workspace/Python/Personal/github.com/notary/LICENSE

::

    $ notary remove --help
    Usage: notary remove [OPTIONS]

    Tries to find a file named LICENSE or LICENSE.md. If one (or both) exists,
    it asks the user if it should go ahead and remove them. Otherwise it exits
    and informs the user that none could be found.

    Options:
    -h, --help  Show this message and exit.

::

    $ notary remove
    The following license file(s) already exist:
    /Users/sorin/Workspace/notary/LICENSE
    Remove /Users/sorin/Workspace/notary/LICENSE? [y/N]: y
    Removed /Users/sorin/Workspace/notary/LICENSE.

::

    $ notary remove
    The following license file(s) already exist:
    /Users/sorin/Workspace/notary/LICENSE
    /Users/sorin/Workspace/notary/LICENSE.md
    /Users/sorin/Workspace/notary/license.rst
    Remove /Users/sorin/Workspace/notary/LICENSE? [y/N]: y
    Removed /Users/sorin/Workspace/notary/LICENSE.
    Remove /Users/sorin/Workspace/notary/LICENSE.md? [y/N]: y
    Removed /Users/sorin/Workspace/notary/LICENSE.md.
    Remove /Users/sorin/Workspace/notary/license.rst? [y/N]: y
    Removed /Users/sorin/Workspace/notary/license.rst.

::

    $ notary remove
    No license file found in the current directory.

.. toctree::
   :maxdepth: 2