Metadata-Version: 2.0
Name: pip-licenses
Version: 1.5.0
Summary: Dump the software license list of Python packages installed with pip.
Home-page: https://github.com/raimon49/pip-licenses
Author: raimon
Author-email: UNKNOWN
License: MIT License
Description-Content-Type: UNKNOWN
Keywords: pip pypi package license check
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: System :: System Shells
Requires-Dist: PTable
Provides-Extra: test
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-pycodestyle; extra == 'test'
Requires-Dist: pytest-runner; extra == 'test'

pip-licenses
============

|Build Status| |PyPI version| |GitHub Release| |Codecov| |BSD License|
|Requirements Status|

Dump the software license list of Python packages installed with pip.

Table of Contents
-----------------

-  `Description <#description>`__
-  `Installation <#installation>`__
-  `Usage <#usage>`__
-  `Command-Line Options <#command-line-options>`__

   -  `Option: from-classifier <#option-from-classifier>`__
   -  `Option: with-system <#option-with-system>`__
   -  `Option: with-authors <#option-with-authors>`__
   -  `Option: with-urls <#option-with-urls>`__
   -  `Option: ignore-packages <#option-ignore-packages>`__
   -  `Option: order <#option-order>`__
   -  `Option: format-markdown <#option-format-markdown>`__
   -  `Option: format-rst <#option-format-rst>`__
   -  `More Information <#more-information>`__

-  `License <#license>`__

   -  `Dependencies <#dependencies>`__

Description
-----------

``pip-licenses`` is a CLI tool for checking the software license of
installed Python packages with pip.

Implemented with the idea inspired by ``composer licenses`` command in
Composer (a.k.a PHP package management tool).

https://getcomposer.org/doc/03-cli.md#licenses

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

Install it via PyPI using ``pip`` command.

.. code:: bash

    # Install or Upgrade to newest available version
    $ pip install -U pip-licenses

Usage
-----

Execute the command with your venv (or virtualenv) environment.

.. code:: bash

    # Install packages in your venv environment
    (venv) $ pip install Django pip-licenses

    # Check the licenses with your venv environment
    (venv) $ pip-licenses
     Name    Version  License
     Django  2.0.2    BSD
     pytz    2017.3   MIT

Command-Line Options
--------------------

Option: from-classifier
~~~~~~~~~~~~~~~~~~~~~~~

By default, this tool finds the license from package Metadata. However,
depending on the type of package, it does not declare a license only in
the Classifiers.

(See also): `Set license to MIT in setup.py by alisianoi ・ Pull Request
#1058 ・
pypa/setuptools <https://github.com/pypa/setuptools/pull/1058>`__, `PEP
314#License <https://www.python.org/dev/peps/pep-0314/#license>`__

If you want to refer to the license declared in Classifiers, use the
``--from-classifier`` option.

.. code:: bash

    (venv) $ pip-licenses --from-classifier --with-system
     Name          Version  License
     Django        2.0.2    BSD License
     PTable        0.9.2    BSD License
     pip           9.0.1    MIT License
     pip-licenses  1.0.0    MIT License
     pytz          2017.3   MIT License
     setuptools    38.5.0   MIT License

Option: with-system
~~~~~~~~~~~~~~~~~~~

By default, system packages such as ``pip`` and ``setuptools`` are
ignored.

If you want to output all including system package, use the
``--with-system`` option.

.. code:: bash

    (venv) $ pip-licenses --with-system
     Name          Version  License
     Django        2.0.2    BSD
     PTable        0.9.2    BSD (3 clause)
     pip           9.0.1    MIT
     pip-licenses  1.0.0    MIT License
     pytz          2017.3   MIT
     setuptools    38.5.0   UNKNOWN

Option: with-authors
~~~~~~~~~~~~~~~~~~~~

When executed with the ``--with-authors`` option, output with author of
the package.

.. code:: bash

    (venv) $ pip-licenses --with-authors
     Name    Version  License  Author
     Django  2.0.2    BSD      Django Software Foundation
     pytz    2017.3   MIT      Stuart Bishop

Option: with-urls
~~~~~~~~~~~~~~~~~

For packages without Metadata, the license is output as ``UNKNOWN``. To
get more package information, use the ``--with-urls`` option.

.. code:: bash

    (venv) $ pip-licenses --with-urls
     Name    Version  License  URL
     Django  2.0.2    BSD      https://www.djangoproject.com/
     pytz    2017.3   MIT      http://pythonhosted.org/pytz

Option: ignore-packages
~~~~~~~~~~~~~~~~~~~~~~~

When executed with the ``--ignore-packages`` option, ignore the package
specified by argument from list output.

.. code:: bash

    (venv) $ pip-licenses --ignore-packages django
     Name  Version  License
     pytz  2017.3   MIT

Package names of arguments can be separated by spaces.

.. code:: bash

    (venv) $ pip-licenses --with-system --ignore-packages django pip pip-licenses
     Name        Version  License
     PTable      0.9.2    BSD (3 clause)
     pytz        2017.3   MIT
     setuptools  38.5.0   UNKNOWN

Option: order
~~~~~~~~~~~~~

By default, it is ordered by package name.

If you give arguments to the ``--order option``, you can output in other
sorted order.

.. code:: bash

    (venv) $ pip-licenses --order=license

Option: format-markdown
~~~~~~~~~~~~~~~~~~~~~~~

When executed with the ``--format-markdown`` option, you can output list
in markdown format.

.. code:: bash

    (venv) $ pip-licenses --format-markdown
    | Name   | Version | License |
    |--------|---------|---------|
    | Django | 2.0.2   | BSD     |
    | pytz   | 2017.3  | MIT     |

When inserted in a markdown document, it is rendered as follows:

+----------+-----------+-----------+
| Name     | Version   | License   |
+==========+===========+===========+
| Django   | 2.0.2     | BSD       |
+----------+-----------+-----------+
| pytz     | 2017.3    | MIT       |
+----------+-----------+-----------+

Option: format-rst
~~~~~~~~~~~~~~~~~~

When executed with the ``--format-rst`` option, you can output list in
"`Grid
tables <http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables>`__"
of reStructuredText format.

.. code:: bash

    (venv) $ pip-licenses --format-rst
    +--------+---------+---------+
    | Name   | Version | License |
    +--------+---------+---------+
    | Django | 2.0.2   | BSD     |
    +--------+---------+---------+
    | pytz   | 2017.3  | MIT     |
    +--------+---------+---------+

More Information
~~~~~~~~~~~~~~~~

Other, please make sure to execute the ``--help`` option.

License
-------

`MIT
License <https://github.com/raimon49/pip-licenses/blob/master/LICENSE>`__

Dependencies
~~~~~~~~~~~~

-  `PTable <https://pypi.python.org/pypi/PTable>`__ by Luke Maurits and
   maintainer of fork version Kane Blueriver under the BSD-3-Clause
   License

``pip-licenses`` has been implemented in the policy to minimize the
dependence on external package.

.. |Build Status| image:: https://travis-ci.org/raimon49/pip-licenses.svg?branch=master
   :target: https://travis-ci.org/raimon49/pip-licenses
.. |PyPI version| image:: https://badge.fury.io/py/pip-licenses.svg
   :target: https://badge.fury.io/py/pip-licenses
.. |GitHub Release| image:: https://img.shields.io/github/release/raimon49/pip-licenses.svg
   :target: https://github.com/raimon49/pip-licenses/releases
.. |Codecov| image:: https://codecov.io/gh/raimon49/pip-licenses/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/raimon49/pip-licenses
.. |BSD License| image:: http://img.shields.io/badge/license-MIT-green.svg
   :target: https://github.com/raimon49/pip-licenses/blob/master/LICENSE
.. |Requirements Status| image:: https://requires.io/github/raimon49/pip-licenses/requirements.svg?branch=master
   :target: https://requires.io/github/raimon49/pip-licenses/requirements/?branch=master


CHANGELOG
---------

1.4.0
~~~~~

-  Implement new option ``--format-markdown``
-  Include LICENSE file in distribution package

1.3.0
~~~~~

-  Implement new option ``--ignore-packages``

1.2.0
~~~~~

-  Implement new option ``--from-classifier``

1.1.0
~~~~~

-  Improve document

   -  Add ToC to README document
   -  Add a information of dependencies

1.0.0
~~~~~

-  First stable release version

0.2.0
~~~~~

-  Implement new option ``--order``

   -  Default behavior is ``--order=name``

0.1.0
~~~~~

-  First implementation version

   -  Support options

      -  ``--with-system``
      -  ``--with-authors``
      -  ``--with-urls``


