Report licenses information for dependencies in use by a Python project
Project description
dep_license
dep_lic: a simple utility to report licenses information for dependencies in use by a Python project. It supports parsing contents from requirements.txt
and Pipfile
files from the project directory or its GitHub repo.
Installation
$ pip install dep_license
Command-Line Options
$ deplic --help
usage: deplic [-h] [-p PROCESSES] [-f FORMAT] [-o OUTPUT] [-d] [-n NAME]
PROJECT
positional arguments:
PROJECT path or URL to the project repo
optional arguments:
-h, --help show this help message and exit
-p PROCESSES, --processes PROCESSES
number of processes to run in parallel (default: MAX)
-f FORMAT, --format FORMAT
define how result is formatted (default: github)
-o OUTPUT, --output OUTPUT
path for output file (default: None)
-d, --dev include dev packages from Pipfile (default: False)
-n NAME, --name NAME name for pip-requirements file (default: None)
Usage
Report a list of dependency licenses used in a local project:
$ deplic /path/to/python/project
Total number of dependencies: 3
Running with 3 processes...
licenses:
| Name | Meta | Classifier |
|------------|--------|--------------------------------------------------|
| pandas | BSD | |
| matplotlib | PSF | OSI Approved::Python Software Foundation License |
| numpy | BSD | OSI Approved |
Specify the file to be parsed:
$ deplic /path/to/python/project/requirements.txt
Total number of dependencies: 1
Running with 1 processes...
licenses:
| Name | Meta | Classifier |
|--------|--------|--------------|
| numpy | BSD | OSI Approved |
Support for Pipfile:
$ deplic /path/to/python/project/Pipfile
Total number of dependencies: 3
Running with 3 processes...
licenses:
| Name | Meta | Classifier |
|------------|--------|--------------------------------------------------|
| numpy | BSD | OSI Approved |
| pandas | BSD | |
| matplotlib | PSF | OSI Approved::Python Software Foundation License |
Format and store output as JSON file:
deplic /path/to/python/project -f json -o dep-licenses.json
Total number of dependencies: 3
Running with 3 processes...
licenses:
[
{
"Name": "matplotlib",
"Meta": "PSF",
"Classifier": "OSI Approved::Python Software Foundation License"
},
{
"Name": "pandas",
"Meta": "BSD",
"Classifier": ""
},
{
"Name": "numpy",
"Meta": "BSD",
"Classifier": "OSI Approved"
}
]
Get the list dev-packages from the project's GitHub repo:
$ deplic https://github.com/kennethreitz/requests -p 16 -d -f md
Total number of dependencies: 16
Running with 16 processes...
licenses:
Name Meta Classifier
--------------- ------------------------------------------------------------ -------------------------------------
pytest MIT license OSI Approved::MIT License
codecov http://www.apache.org/licenses/LICENSE-2.0 OSI Approved::Apache Software License
pytest-mock MIT OSI Approved::MIT License
sphinx BSD OSI Approved::BSD License
tox MIT OSI Approved::MIT License
pytest-httpbin MIT OSI Approved::MIT License
docutils public domain, Python, 2-Clause BSD, GPL 3 (see COPYING.txt) Public Domain
pytest-cov MIT OSI Approved::BSD License
pytest-xdist MIT OSI Approved::MIT License
pysocks BSD
httpbin MIT OSI Approved::MIT License
alabaster OSI Approved::BSD License
readme-renderer Apache License, Version 2.0 OSI Approved::Apache Software License
detox MIT OSI Approved::MIT License
Specify which requirements file to parse:
$ deplic https://github.com/pandas-dev/pandas -n requirements-dev.txt -f csv -p 16 -o pandas_dev.csv
Output Formats:
Supported table formats are (thanks to python-tabulate package):
- "plain"
- "simple"
- "github"
- "grid"
- "fancy_grid"
- "pipe"
- "orgtbl"
- "jira"
- "presto"
- "psql"
- "rst"
- "mediawiki"
- "moinmoin"
- "youtrack"
- "html"
- "latex"
- "latex_raw"
- "latex_booktabs"
- "textile"
- "csv"
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for dep_license-0.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a1036bab1e959031efa00bacabed4c5f3f33e958758cf5c79069738c7836e67 |
|
MD5 | 995f0e800eaeb9c0bb8736157279844f |
|
BLAKE2b-256 | c61c520e9d5d1fb23e292ae619ccaa69de33b2d43ccc8265b3979f858690a12d |