| Name | pip-licenses-cli JSON |
| Version |
2.0.0
JSON |
| download |
| home_page | None |
| Summary | Dump the software license list of Python packages installed with pip. |
| upload_time | 2025-07-30 09:35:29 |
| maintainer | stefan6419846 |
| docs_url | None |
| author | None |
| requires_python | <4,>=3.9 |
| license | None |
| keywords |
pip
pypi
package
license
check
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pip-licenses-cli
Dump the software license list of Python packages installed with *pip*.
## Description
`pip-licenses-cli` is a CLI tool for checking the software licenses 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
This is a fork of the original [pip-licenses](https://github.com/raimon49/pip-licenses) project. While `pip-licenses-cli` provides a CLI,
[pip-licenses-lib](https://github.com/stefan6419846/pip-licenses-lib) provides the library functionality. The CLI builds upon the library.
## Installation
You can install this package from PyPI:
```bash
python -m pip install pip-licenses-cli
```
If you want to additionally parse license declarations with [SPDX expressions](https://peps.python.org/pep-0639/#spdx-license-expression-syntax), then also install the `spdx` extra:
```bash
python -m pip install 'pip-licenses-cli[spdx]'
```
Alternatively, you can use the package from source directly after installing the required dependencies.
## Usage
Execute the command with your venv (or virtualenv) environment.
```bash
# Install packages in your venv environment
(venv) $ pip install Django pip-licenses-cli
# Check the licenses with your venv environment
(venv) $ pip-licenses
Name Version License
Django 2.0.2 BSD
pytz 2017.3 MIT
```
For further details, see [the detailed docs](https://github.com/stefan6419846/pip-licenses-cli/blob/master/USAGE.md).
## About UnicodeEncodeError
If a `UnicodeEncodeError` occurs, check your environment variables `LANG` and `LC_TYPE`.
Additionally, you can set `PYTHONIOENCODING` to override the encoding used for `stdout`.
This mostly occurs in isolated environments such as Docker and tox.
See useful reports:
* [#35](https://github.com/raimon49/pip-licenses/issues/35)
* [#45](https://github.com/raimon49/pip-licenses/issues/45)
### Dependencies
`pip-licenses-cli` has been implemented in the policy to minimize the dependencies on external packages.
* [pip-licenses-lib](https://pypi.org/project/pip-licenses-lib/) by the same authors as the CLI (MIT License).
* [prettytable](https://pypi.org/project/prettytable/) by Luke Maurits, subject to the BSD-3-Clause License.
* **Note:** This package implicitly requires [wcwidth](https://pypi.org/project/wcwidth/) by Jeff Quast (MIT License).
* For Python < 3.11: [tomli](https://pypi.org/project/tomli/) by Taneli Hukkinen under the MIT License.
If you are using SPDX support with the `spdx` extra, the following additional dependencies are required:
* [license-expression](https://pypi.org/project/license-expression/) by nexB Inc. under the Apache-2.0 License.
* [boolean.py](https://pypi.org/project/boolean.py/) by Sebastian Krämer under the BSD-2-Clause License.
## Contributing
See [contribution guidelines](https://github.com/stefan6419846/pip-licenses-cli/blob/master/CONTRIBUTING.md).
## License
This package is subject to the terms of the MIT license.
## Disclaimer
All results are generated automatically from the data supplied by the corresponding package maintainers and provided on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. No generated content should be considered or used as legal advice.
Consult an Attorney for any legal advice.
Raw data
{
"_id": null,
"home_page": null,
"name": "pip-licenses-cli",
"maintainer": "stefan6419846",
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "pip, pypi, package, license, check",
"author": null,
"author_email": "raimon <raimon49@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/1c/9f/d0edd6b5e246c46cd949758cd5f1a42603124f3d43240aa56a9712a5a2de/pip_licenses_cli-2.0.0.tar.gz",
"platform": null,
"description": "# pip-licenses-cli\n\nDump the software license list of Python packages installed with *pip*.\n\n## Description\n\n`pip-licenses-cli` is a CLI tool for checking the software licenses of installed Python packages with pip.\n\nImplemented with the idea inspired by `composer licenses` command in Composer (a.k.a PHP package management tool):\nhttps://getcomposer.org/doc/03-cli.md#licenses\n\nThis is a fork of the original [pip-licenses](https://github.com/raimon49/pip-licenses) project. While `pip-licenses-cli` provides a CLI,\n[pip-licenses-lib](https://github.com/stefan6419846/pip-licenses-lib) provides the library functionality. The CLI builds upon the library.\n\n## Installation\n\nYou can install this package from PyPI:\n\n```bash\npython -m pip install pip-licenses-cli\n```\n\nIf you want to additionally parse license declarations with [SPDX expressions](https://peps.python.org/pep-0639/#spdx-license-expression-syntax), then also install the `spdx` extra:\n\n```bash\npython -m pip install 'pip-licenses-cli[spdx]'\n```\n\nAlternatively, you can use the package from source directly after installing the required dependencies.\n\n## Usage\n\nExecute the command with your venv (or virtualenv) environment.\n\n```bash\n# Install packages in your venv environment\n(venv) $ pip install Django pip-licenses-cli\n\n# Check the licenses with your venv environment\n(venv) $ pip-licenses\n Name Version License\n Django 2.0.2 BSD\n pytz 2017.3 MIT\n```\n\nFor further details, see [the detailed docs](https://github.com/stefan6419846/pip-licenses-cli/blob/master/USAGE.md).\n\n## About UnicodeEncodeError\n\nIf a `UnicodeEncodeError` occurs, check your environment variables `LANG` and `LC_TYPE`.\nAdditionally, you can set `PYTHONIOENCODING` to override the encoding used for `stdout`.\n\nThis mostly occurs in isolated environments such as Docker and tox.\n\nSee useful reports:\n\n* [#35](https://github.com/raimon49/pip-licenses/issues/35)\n* [#45](https://github.com/raimon49/pip-licenses/issues/45)\n\n### Dependencies\n\n`pip-licenses-cli` has been implemented in the policy to minimize the dependencies on external packages.\n\n* [pip-licenses-lib](https://pypi.org/project/pip-licenses-lib/) by the same authors as the CLI (MIT License).\n* [prettytable](https://pypi.org/project/prettytable/) by Luke Maurits, subject to the BSD-3-Clause License.\n * **Note:** This package implicitly requires [wcwidth](https://pypi.org/project/wcwidth/) by Jeff Quast (MIT License).\n* For Python < 3.11: [tomli](https://pypi.org/project/tomli/) by Taneli Hukkinen under the MIT License.\n\nIf you are using SPDX support with the `spdx` extra, the following additional dependencies are required:\n\n* [license-expression](https://pypi.org/project/license-expression/) by nexB Inc. under the Apache-2.0 License.\n* [boolean.py](https://pypi.org/project/boolean.py/) by Sebastian Kr\u00e4mer under the BSD-2-Clause License.\n\n## Contributing\n\nSee [contribution guidelines](https://github.com/stefan6419846/pip-licenses-cli/blob/master/CONTRIBUTING.md).\n\n\n## License\n\nThis package is subject to the terms of the MIT license.\n\n## Disclaimer\n\nAll results are generated automatically from the data supplied by the corresponding package maintainers and provided on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. No generated content should be considered or used as legal advice.\nConsult an Attorney for any legal advice.\n",
"bugtrack_url": null,
"license": null,
"summary": "Dump the software license list of Python packages installed with pip.",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/stefan6419846/pip-licenses-cli",
"Issues": "https://github.com/stefan6419846/pip-licenses-cli/issues",
"Releases": "https://github.com/stefan6419846/pip-licenses-cli/releases"
},
"split_keywords": [
"pip",
" pypi",
" package",
" license",
" check"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "75cab4f03ec0a5678343de70746552e507440f60ae33fbf641f2a6ace2ba1d7e",
"md5": "a62e4d8f31571251b50bd171af8f19c9",
"sha256": "9e49a34bd9613bd3c2133e8edb5726338134ad0e748df502fe9881cd3a140456"
},
"downloads": -1,
"filename": "pip_licenses_cli-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a62e4d8f31571251b50bd171af8f19c9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 15870,
"upload_time": "2025-07-30T09:35:28",
"upload_time_iso_8601": "2025-07-30T09:35:28.216872Z",
"url": "https://files.pythonhosted.org/packages/75/ca/b4f03ec0a5678343de70746552e507440f60ae33fbf641f2a6ace2ba1d7e/pip_licenses_cli-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1c9fd0edd6b5e246c46cd949758cd5f1a42603124f3d43240aa56a9712a5a2de",
"md5": "6e1fffe1c9cd0ea8273a71472bbbf574",
"sha256": "ddbd4d5fff2270b66d515d5737f0145bc35ed42b9179f684c0f5f020d33e4320"
},
"downloads": -1,
"filename": "pip_licenses_cli-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "6e1fffe1c9cd0ea8273a71472bbbf574",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 20890,
"upload_time": "2025-07-30T09:35:29",
"upload_time_iso_8601": "2025-07-30T09:35:29.549766Z",
"url": "https://files.pythonhosted.org/packages/1c/9f/d0edd6b5e246c46cd949758cd5f1a42603124f3d43240aa56a9712a5a2de/pip_licenses_cli-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-30 09:35:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "stefan6419846",
"github_project": "pip-licenses-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pip-licenses-cli"
}
