A command line tool for generating project dependencies table
Project description
leafhopper
Do you get asked for a list of open source projects you used in the project for legal review?
leafhopper
is a command line tool used for generating a table of dependencies for a project, so that you don't have to manually maintain such a list.
how it works
The tool parses the project descriptor, based on different project type (poetry
/maven
/vcpkg
are supported currently), and generates a table of dependencies. When some critical information, such as license, is not available in the project descriptor, leafhopper
will test if this is a github/sourceforge project and try loading relevant information from github.com/sourceforge.net.
installation
pip install leafhopper
usage
leafhopper /path/to/project/descriptor
arguments
--format
: the format of the output. Possible values aremarkdown
/html
/json
/latex
/csv
. Default ismarkdown
.--output
: the output file path. If not specified, the output will be printed to stdout.--logging-level
: the logging level. Possible values aredebug
/info
/warning
/error
/critical
. Default isinfo
.- Set the logging level to above
info
(e.g.error
) to supress non critical messages so that only table is printed to stdout (if no output file is specified). - Set the logging level to
debug
to enable debug messages.
- Set the logging level to above
examples
- extract
pyproject.toml
dependencies with markdown format and save it intodependencies.md
file
leafhopper /path/to/pyproject.toml --output=dependencies.md
- extract
pom.xml
dependencies with html format
leaphopper /path/to/pom.xml --format=html
- suppress logging and output to stdout and use CLI tool
glow
to display it
leafhopper /path/to/vcpkg.json --format md --logging-level error | glow -
supported formats
- markdown
- LaTex
- html
- json
- csv
supported project types
- poetry project described by
pyproject.toml
- maven project described by
pom.xml
- https://maven.apache.org/pom.html
pom.xml
with or without Maven XML namespace are supported.
- vcpkg project described by
vcpkg.json
- more project types such as npm will be supported in the future
Changelog
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 Distribution
Built Distribution
Hashes for leafhopper-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc43949d69fa8c8409c3d9fe147e778f6e16f7e08de497053c22bb1a85e8d8f3 |
|
MD5 | 6acd60c21ab7d093828385c978880a71 |
|
BLAKE2b-256 | 94e67344dd56aeda2c03ede9b2aa052f722a4edef1a1591d0d20f792214691d8 |