pip-licenses 1.2.0

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

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

Table of Contents

• Description
• Installation
• Usage
• Command-Line Options
  • –from-classifier
  • –with-system
  • –with-authors
  • –with-urls
  • –order
  • More Information
• License
  • 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.

$ pip install pip-licenses

Usage

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

# 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

–from-classifier

By default, this tool finds the license from package METADATA or PKG-INFO. 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

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

(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

–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.

(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

–with-authors

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

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

–with-urls

For packages without METADATA (or PKG-INFO or Classifiers), the license is output as UNKNOWN. To get more package information, use the --with-urls option.

(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

–order

By default, it is ordered by package name.

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

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

More Information

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

License

MIT License

Dependencies

• PTable by Luke Maurits and maintainer of fork version Kane Blueriver under the BSD-3-Clause License

CHANGELOG

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