visualize a dependency graph for a python library
Given a python library (or any folder of python files), create a graph of the dependencies between the modules. By default:
- parent folder has a black arrow to child folders or files
- imports between files are red arrows
- imports in an
__init__.pyfrom a downstream file are dashed blue arrows
The script also lets the git remote url be auto-detected, making all the nodes in the graph into clickable links (for svg, at least)
(you can view more examples in the examples folder)
To generate a graph:
python -m dep_graph_viz <library_path> <output_base> [optional-arguments]
To print help message:
python -m dep_graph_viz -h
Below are the contents of that help message:
root: str(REQUIRED) root directory to search for Python filesoutput: stroutput filename (without extension) default:"output"output_fmt: Literal["svg", "png"]output format for runningdotdefault:"svg"
config_file: str | None = Nonepath to a JSON file containing configuration optionsprint_cfg: bool = Falsewhether to print the configuration after loading it -- if this is set, the program will exit after printing the configverbose: bool = Falsehorhelpprint this help message and exit
Either specify these in a json file, or separate levels with a dot.
url_prefix: str|Nonemanually add a prefix to the url. if set toNone, will try to auto-detect from gitauto_url_format: str|Nonehow to format a url given the git remote url and branch name. default: "{git_remote_url}/tree/{git_branch}/" (which works for github) set toNoneto disable. if both this andurl_prefixare none, the svg will not have URLsauto_url_replace: dict[str,str]string-replace pairs to apply to the git remote url before formatting it note: trailing slashes are also stripped default:{".git": ""}node.dir: dict|Nonekwargs for directory nodesnode.file: dict|Nonekwargs for file nodesedge.heirarchy: dict|Nonekwargs for hierarchy edges (i.e. file A is part of module B)edge.uses: dict|Nonekwargs for uses edges (i.e. file A imports module B for using it)edge.inits: dict|Nonekwargs for init edges (i.e. init.py file imports something from downstream of itself)dot_attrs: dictkwargs for the dot graph itself default:{'rankdir': 'TB'}(top to bottom) you can change it viadot_attrs.rankdir=LRfor left to right, etc.
To modify an element of a dict without specifying the whole dict, you can use "." as a level separator:
--edge.uses.color=green
Install via pip from github
pip install git+https://github.com/mivanit/dep-graph-viz
You also need GraphViz, specifically the dot layout engine, installed and in your PATH.