pipforester 1.0.1

A tool to analyze the dependency graph of a pip package.

pipforester

Forester tools for pipdeptree outputs to analyze and cleanup the dependency graph of installed pip packages.

Features

• clean up a graph to remove direct dependencies if a transitive dependency exists and output it as dot-file.
• detect transitive cyclic dependencies
  • color them in the graph
  • show them as separate graphs in one dot-file
  • exit pipforester with exit code 1 if there are cycles detected

Installation:

• Create an empty virtual environment, separate from the environment to work on.
• pip install pipdeptree pipforester

Dependent on your operation system you

• want to install a program to view dot-files, like xdot i.e. with apt install xdot on Debian/Ubuntu-based systems.
• or use graphviz to convert dot-files to PNG/SVG.

Usage

First, call pipdeptree on a virtual environment to create a JSON file of the installed dependencies, and second call pipforester to create a cleaned-up dot file.

pipdeptree --python  path/to/venv/bin/python -j >forest.json
pipforester -i forest.json -o forest.dot

Finally use a Graphviz DOT-file visualizer, i.e. xdot on Linux, to view the graph.

xdot forest.dot

Or use the dot command line program to generate an SVG or PNG:

dot -Tsvg -o forest.svg forest.dot
dot -Tpng -o forest.png forest.dot

To generate a graph containing only cyclic transitive dependencies, use the --cycles option:

pipdeptree -j >forest.json
pipforester -i forest.json -o forest.dot --cycles

To detect cyclic transitive dependencies and exit with 1 if there is at least one, use the --check-cycles option. It does not generate an output graph and is meant for usage in CI.

pipdeptree -j >forest.json
pipforester -i forest.json --check-cycles

See pipforester --help for details.

Changes

1.0.1 (2023-07-14)

• use transitive_reduction from the NetworkX module to speed up edge removal. [@gogobd]

1.0.0 (2023-05-16)

• fix the cyclic dependency display to show all edges of a cycle in dark violet. [@jensens]
• fix graph of cycles not to show graph multiple times. [@jensens]

1.0.0a1 (2023-05-15)

• initial code [@jensens]

License

Copyright (c) 2022-2023, mxstack Contributors

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.