/pkgviz-python

Framework to visualise python packages

Primary LanguagePythonMIT LicenseMIT

logo

pkgviz-python

Framework to visualise python packages.

license Python 3.10 PyPI version Code Check CI

Getting Started

Pre-requisites:

The package uses graphviz as a dependency. You will need to install the required binaries for it.

  • Linux: sudo apt install graphviz
  • MacOS: brew install graphviz

Refer to https://graphviz.org/download/ for more installation options.

Note: It is recommended to setup a virtual environment of your choice before installing the package.

Install from PyPI:

pip install pkgviz-python

Install from source:

git clone https://github.com/AjinkyaIndulkar/pkgviz-python
cd pkgviz-python
pip install .

CLI Usage

Run the following command to generate a graph visualisation of the math package:

pkgviz -p math -o output/viz.svg

The above command should generate an SVG output as below:

demo-viz