https://github.com/dotcs/pylicense
PyLicense is a CLI tool that queries license information from one of the following package repositories: PyPI, Anaconda or conda-forge.
https://github.com/dotcs/pylicense
cli license license-checker license-checking python python3
Last synced: 12 months ago
JSON representation
PyLicense is a CLI tool that queries license information from one of the following package repositories: PyPI, Anaconda or conda-forge.
- Host: GitHub
- URL: https://github.com/dotcs/pylicense
- Owner: dotcs
- License: gpl-3.0
- Created: 2020-09-19T09:42:36.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2020-09-19T21:24:02.000Z (over 5 years ago)
- Last Synced: 2025-05-07T17:18:41.135Z (about 1 year ago)
- Topics: cli, license, license-checker, license-checking, python, python3
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyLicense
PyLicense is a CLI tool that queries license information from one of the
following package repositories: PyPI, Anaconda or conda-forge.
PyLicense uses the online information of those repositories, e.g. the license
information that is listed on `pypi.org/pypi/`, e.g. https://pypi.org/project/dcs-pylicense/.
While this means that the package must not be installed on the local system,
it also shows information about the lastest package version and not every
possible package version.
## Installation
To install the package run
```console
$ pip install dcs-pylicense
```
The tool registers itself as `pylicense`.
To learn about the available arguments refer to its help:
```console
$ pylicense --help
```
## Usage
PyLicense requires a file in the format of a requirements file.
The format is described [here](https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format).
To query license information of the packages run
```console
$ pylicense path/to/my/requirements.txt
| name | license | version |
|:-----------|:----------|:----------|
| black | MIT | 20.8b1 |
| pylint | GPL | 2.6.0 |
| pytest | MIT | 6.0.2 |
| pytest-cov | MIT | 2.10.1 |
| sphinx | BSD | 3.2.1 |
| twine | unknown | 3.2.1 |
```
It is also possible to read from stdin
```console
$ cat /path/to/my/requirements.txt | pylicense
```
By default the result is returned as a markdown table.
Other format options are available, e.g. output formatting as CSV.
```console
$ pylicense --output-format csv path/to/my/requirements.txt
name|license|version
black|MIT|20.8b1
pylint|GPL|2.6.0
pytest|MIT|6.0.2
pytest-cov|MIT|2.10.1
sphinx|BSD|3.2.1
twine|unknown|3.2.1
```
By default the [Python Package Index (PyPI)](https://pypi.org) is queried.
This can be changed with the `--repository` flag.
For example to query the anaconda package repository use the following command
```console
$ pylicense --repository anaconda path/to/my/requirements.txt
| name | license | version |
|:-----------|:-------------|:----------|
| black | MIT | 19.10b0 |
| pylint | GPL-2 | 2.6.0 |
| pytest | MIT | 6.0.2 |
| pytest-cov | MIT | 2.10.1 |
| sphinx | BSD-2-Clause | 3.2.1 |
| twine | Apache 2 | 2.0.0 |
```