Awesome
Dependenpy
Show the inter-dependencies between modules of Python packages.
dependenpy
allows you to build a dependency matrix for a set of Python packages.
To do this, it reads and searches the source code for import statements.
Installation
With pip
:
pip install dependenpy
With pipx
:
python3.8 -m pip install --user pipx
pipx install dependenpy
Usage (as a library)
from dependenpy import DSM
# create DSM
dsm = DSM('django')
# transform as matrix
matrix = dsm.as_matrix(depth=2)
# initialize with many packages
dsm = DSM('django', 'meerkat', 'appsettings', 'dependenpy', 'archan')
with open('output', 'w') as output:
dsm.print(format='json', indent=2, output=output)
# access packages and modules
meerkat = dsm['meerkat'] # or dsm.get('meerkat')
finder = dsm['dependenpy.finder'] # or even dsm['dependenpy']['finder']
# instances of DSM and Package all have print, as_matrix, etc. methods
meerkat.print_matrix(depth=2)
This package was originally design to work in a Django project. The Django package django-meerkat uses it to display the matrices with Highcharts.
Usage (command-line)
usage: dependenpy [-d DEPTH] [-f {csv,json,text}] [-g] [-G] [-h]
[-i INDENT] [-l] [-m] [-o OUTPUT] [-t] [-v]
[-z STRING] PACKAGES [PACKAGES ...]
Command line tool for dependenpy Python package.
positional arguments:
PACKAGES The package list. Can be a comma-separated list. Each
package must be either a valid path or a package in
PYTHONPATH.
optional arguments:
-d DEPTH, --depth DEPTH
Specify matrix or graph depth. Default: best guess.
-f {csv,json,text}, --format {csv,json,text}
Output format. Default: text.
-g, --show-graph Show the graph (no text format). Default: false.
-G, --greedy Explore subdirectories even if they do not contain an
__init__.py file. Can make execution slower. Default:
false.
-h, --help Show this help message and exit.
-i INDENT, --indent INDENT
Specify output indentation. CSV will never be
indented. Text will always have new-lines. JSON can be
minified with a negative value. Default: best guess.
-l, --show-dependencies-list
Show the dependencies list. Default: false.
-m, --show-matrix Show the matrix. Default: true unless -g, -l or -t.
-o OUTPUT, --output OUTPUT
Output to given file. Default: stdout.
-t, --show-treemap Show the treemap (work in progress). Default: false.
-v, --version Show the current version of the program and exit.
-z ZERO, --zero ZERO Character to use for cells with value=0 (text matrix
display only). Default: "0".
Example:
$ # running dependenpy on itself
$ dependenpy dependenpy -z=
Module │ Id │0│1│2│3│4│5│6│7│8│
──────────────────────┼────┼─┼─┼─┼─┼─┼─┼─┼─┼─┤
dependenpy.__init__ │ 0 │ │ │ │4│ │ │ │ │2│
dependenpy.__main__ │ 1 │ │ │1│ │ │ │ │ │ │
dependenpy.cli │ 2 │1│ │ │1│ │4│ │ │ │
dependenpy.dsm │ 3 │ │ │ │ │2│1│3│ │ │
dependenpy.finder │ 4 │ │ │ │ │ │ │ │ │ │
dependenpy.helpers │ 5 │ │ │ │ │ │ │ │ │ │
dependenpy.node │ 6 │ │ │ │ │ │ │ │ │3│
dependenpy.plugins │ 7 │ │ │ │1│ │1│ │ │ │
dependenpy.structures │ 8 │ │ │ │ │ │1│ │ │ │