Help with some use cases

[sandeep026]

I am creating a package and before packaging, I want to see the dependency tree using pipdeptree. How to go about it?
Just "pipdeptree" does exactly what? Why is numpy not listed by pipdeptree.

From pip list

** from pipdeptree**

build==1.0.3
├── colorama [required: Any, installed: 0.4.6]
├── packaging [required: >=19.0, installed: 23.2]
└── pyproject_hooks [required: Any, installed: 1.0.0]
CacheControl==0.13.1
├── msgpack [required: >=0.5.2, installed: 1.0.7]
└── requests [required: >=2.16.0, installed: 2.31.0]
    ├── certifi [required: >=2017.4.17, installed: 2024.2.2]
    ├── charset-normalizer [required: >=2,<4, installed: 3.3.2]
    ├── idna [required: >=2.5,<4, installed: 3.6]
    └── urllib3 [required: >=1.21.1,<3, installed: 2.2.1]
casadi==3.6.5
└── numpy [required: Any, installed: 1.26.4]
cleo==2.1.0
├── crashtest [required: >=0.4.1,<0.5.0, installed: 0.4.1]
└── rapidfuzz [required: >=3.0.0,<4.0.0, installed: 3.6.1]
dulwich==0.21.7
└── urllib3 [required: >=1.25, installed: 2.2.1]
installer==0.7.0
ipykernel==6.29.2
├── comm [required: >=0.1.1, installed: 0.2.1]
│   └── traitlets [required: >=4, installed: 5.14.1]
├── debugpy [required: >=1.6.5, installed: 1.8.1]
├── ipython [required: >=7.23.1, installed: 8.22.0]
│   ├── colorama [required: Any, installed: 0.4.6]
│   ├── decorator [required: Any, installed: 5.1.1]
│   ├── jedi [required: >=0.16, installed: 0.19.1]
│   │   └── parso [required: >=0.8.3,<0.9.0, installed: 0.8.3]
│   ├── matplotlib-inline [required: Any, installed: 0.1.6]
│   │   └── traitlets [required: Any, installed: 5.14.1]
│   ├── prompt-toolkit [required: >=3.0.41,<3.1.0, installed: 3.0.43]
│   │   └── wcwidth [required: Any, installed: 0.2.13]
│   ├── Pygments [required: >=2.4.0, installed: 2.17.2]
│   ├── stack-data [required: Any, installed: 0.6.3]
│   │   ├── asttokens [required: >=2.1.0, installed: 2.4.1]
│   │   │   └── six [required: >=1.12.0, installed: 1.16.0]
│   │   ├── executing [required: >=1.2.0, installed: 2.0.1]
│   │   └── pure-eval [required: Any, installed: 0.2.2]
│   └── traitlets [required: >=5, installed: 5.14.1]
├── jupyter_client [required: >=6.1.12, installed: 8.6.0]
│   ├── jupyter_core [required: >=4.12,!=5.0.*, installed: 5.7.1]
│   │   ├── platformdirs [required: >=2.5, installed: 3.11.0]
│   │   ├── pywin32 [required: >=300, installed: 306]
│   │   └── traitlets [required: >=5.3, installed: 5.14.1]
│   ├── python-dateutil [required: >=2.8.2, installed: 2.8.2]
│   │   └── six [required: >=1.5, installed: 1.16.0]
│   ├── pyzmq [required: >=23.0, installed: 25.1.2]
│   ├── tornado [required: >=6.2, installed: 6.4]
│   └── traitlets [required: >=5.3, installed: 5.14.1]
├── jupyter_core [required: >=4.12,!=5.0.*, installed: 5.7.1]
│   ├── platformdirs [required: >=2.5, installed: 3.11.0]
│   ├── pywin32 [required: >=300, installed: 306]
│   └── traitlets [required: >=5.3, installed: 5.14.1]
├── matplotlib-inline [required: >=0.1, installed: 0.1.6]
│   └── traitlets [required: Any, installed: 5.14.1]
├── nest-asyncio [required: Any, installed: 1.6.0]
├── packaging [required: Any, installed: 23.2]
├── psutil [required: Any, installed: 5.9.8]
├── pyzmq [required: >=24, installed: 25.1.2]
├── tornado [required: >=6.1, installed: 6.4]
└── traitlets [required: >=5.4.0, installed: 5.14.1]
keyring==24.3.0
├── importlib-metadata [required: >=4.11.4, installed: 7.0.1]
│   └── zipp [required: >=0.5, installed: 3.17.0]
├── jaraco.classes [required: Any, installed: 3.3.1]
│   └── more-itertools [required: Any, installed: 10.2.0]
└── pywin32-ctypes [required: >=0.2.0, installed: 0.2.2]
matplotlib==3.8.3
├── contourpy [required: >=1.0.1, installed: 1.2.0]
│   └── numpy [required: >=1.20,<2.0, installed: 1.26.4]
├── cycler [required: >=0.10, installed: 0.12.1]
├── fonttools [required: >=4.22.0, installed: 4.49.0]
├── kiwisolver [required: >=1.3.1, installed: 1.4.5]
├── numpy [required: >=1.21,<2, installed: 1.26.4]
├── packaging [required: >=20.0, installed: 23.2]
├── pillow [required: >=8, installed: 10.2.0]
├── pyparsing [required: >=2.3.1, installed: 3.1.1]
└── python-dateutil [required: >=2.7, installed: 2.8.2]
    └── six [required: >=1.5, installed: 1.16.0]
nbsphinx==0.9.3
├── docutils [required: Any, installed: 0.20.1]
├── Jinja2 [required: Any, installed: 3.1.3]
│   └── MarkupSafe [required: >=2.0, installed: 2.1.5]
├── nbconvert [required: !=5.4, installed: 7.16.1]
│   ├── beautifulsoup4 [required: Any, installed: 4.12.3]
│   │   └── soupsieve [required: >1.2, installed: 2.5]
│   ├── bleach [required: !=5.0.0, installed: 6.1.0]
│   │   ├── six [required: >=1.9.0, installed: 1.16.0]
│   │   └── webencodings [required: Any, installed: 0.5.1]
│   ├── defusedxml [required: Any, installed: 0.7.1]
│   ├── Jinja2 [required: >=3.0, installed: 3.1.3]
│   │   └── MarkupSafe [required: >=2.0, installed: 2.1.5]
│   ├── jupyter_core [required: >=4.7, installed: 5.7.1]
│   │   ├── platformdirs [required: >=2.5, installed: 3.11.0]
│   │   ├── pywin32 [required: >=300, installed: 306]
│   │   └── traitlets [required: >=5.3, installed: 5.14.1]
│   ├── jupyterlab_pygments [required: Any, installed: 0.3.0]
│   ├── MarkupSafe [required: >=2.0, installed: 2.1.5]
│   ├── mistune [required: >=2.0.3,<4, installed: 3.0.2]
│   ├── nbclient [required: >=0.5.0, installed: 0.9.0]
│   │   ├── jupyter_client [required: >=6.1.12, installed: 8.6.0]
│   │   │   ├── jupyter_core [required: >=4.12,!=5.0.*, installed: 5.7.1]
│   │   │   │   ├── platformdirs [required: >=2.5, installed: 3.11.0]
│   │   │   │   ├── pywin32 [required: >=300, installed: 306]
│   │   │   │   └── traitlets [required: >=5.3, installed: 5.14.1]
│   │   │   ├── python-dateutil [required: >=2.8.2, installed: 2.8.2]
│   │   │   │   └── six [required: >=1.5, installed: 1.16.0]
│   │   │   ├── pyzmq [required: >=23.0, installed: 25.1.2]
│   │   │   ├── tornado [required: >=6.2, installed: 6.4]
│   │   │   └── traitlets [required: >=5.3, installed: 5.14.1]
│   │   ├── jupyter_core [required: >=4.12,!=5.0.*, installed: 5.7.1]
│   │   │   ├── platformdirs [required: >=2.5, installed: 3.11.0]
│   │   │   ├── pywin32 [required: >=300, installed: 306]
│   │   │   └── traitlets [required: >=5.3, installed: 5.14.1]
│   │   ├── nbformat [required: >=5.1, installed: 5.9.2]
│   │   │   ├── fastjsonschema [required: Any, installed: 2.19.1]
│   │   │   ├── jsonschema [required: >=2.6, installed: 4.21.1]
│   │   │   │   ├── attrs [required: >=22.2.0, installed: 23.2.0]
│   │   │   │   ├── jsonschema-specifications [required: >=2023.03.6, installed: 2023.12.1]
│   │   │   │   │   └── referencing [required: >=0.31.0, installed: 0.33.0]
│   │   │   │   │       ├── attrs [required: >=22.2.0, installed: 23.2.0]
│   │   │   │   │       └── rpds-py [required: >=0.7.0, installed: 0.18.0]
│   │   │   │   ├── referencing [required: >=0.28.4, installed: 0.33.0]
│   │   │   │   │   ├── attrs [required: >=22.2.0, installed: 23.2.0]
│   │   │   │   │   └── rpds-py [required: >=0.7.0, installed: 0.18.0]
│   │   │   │   └── rpds-py [required: >=0.7.1, installed: 0.18.0]
│   │   │   ├── jupyter_core [required: Any, installed: 5.7.1]
│   │   │   │   ├── platformdirs [required: >=2.5, installed: 3.11.0]
│   │   │   │   ├── pywin32 [required: >=300, installed: 306]
│   │   │   │   └── traitlets [required: >=5.3, installed: 5.14.1]
│   │   │   └── traitlets [required: >=5.1, installed: 5.14.1]
│   │   └── traitlets [required: >=5.4, installed: 5.14.1]
│   ├── nbformat [required: >=5.7, installed: 5.9.2]
│   │   ├── fastjsonschema [required: Any, installed: 2.19.1]
│   │   ├── jsonschema [required: >=2.6, installed: 4.21.1]
│   │   │   ├── attrs [required: >=22.2.0, installed: 23.2.0]
│   │   │   ├── jsonschema-specifications [required: >=2023.03.6, installed: 2023.12.1]
│   │   │   │   └── referencing [required: >=0.31.0, installed: 0.33.0]
│   │   │   │       ├── attrs [required: >=22.2.0, installed: 23.2.0]
│   │   │   │       └── rpds-py [required: >=0.7.0, installed: 0.18.0]
│   │   │   ├── referencing [required: >=0.28.4, installed: 0.33.0]
│   │   │   │   ├── attrs [required: >=22.2.0, installed: 23.2.0]
│   │   │   │   └── rpds-py [required: >=0.7.0, installed: 0.18.0]
│   │   │   └── rpds-py [required: >=0.7.1, installed: 0.18.0]
│   │   ├── jupyter_core [required: Any, installed: 5.7.1]
│   │   │   ├── platformdirs [required: >=2.5, installed: 3.11.0]
│   │   │   ├── pywin32 [required: >=300, installed: 306]
│   │   │   └── traitlets [required: >=5.3, installed: 5.14.1]
│   │   └── traitlets [required: >=5.1, installed: 5.14.1]
│   ├── packaging [required: Any, installed: 23.2]
│   ├── pandocfilters [required: >=1.4.1, installed: 1.5.1]
│   ├── Pygments [required: >=2.4.1, installed: 2.17.2]
│   ├── tinycss2 [required: Any, installed: 1.2.1]
│   │   └── webencodings [required: >=0.4, installed: 0.5.1]
│   └── traitlets [required: >=5.1, installed: 5.14.1]
├── nbformat [required: Any, installed: 5.9.2]
│   ├── fastjsonschema [required: Any, installed: 2.19.1]
│   ├── jsonschema [required: >=2.6, installed: 4.21.1]
│   │   ├── attrs [required: >=22.2.0, installed: 23.2.0]
│   │   ├── jsonschema-specifications [required: >=2023.03.6, installed: 2023.12.1]
│   │   │   └── referencing [required: >=0.31.0, installed: 0.33.0]
│   │   │       ├── attrs [required: >=22.2.0, installed: 23.2.0]
│   │   │       └── rpds-py [required: >=0.7.0, installed: 0.18.0]
│   │   ├── referencing [required: >=0.28.4, installed: 0.33.0]
│   │   │   ├── attrs [required: >=22.2.0, installed: 23.2.0]
│   │   │   └── rpds-py [required: >=0.7.0, installed: 0.18.0]
│   │   └── rpds-py [required: >=0.7.1, installed: 0.18.0]
│   ├── jupyter_core [required: Any, installed: 5.7.1]
│   │   ├── platformdirs [required: >=2.5, installed: 3.11.0]
│   │   ├── pywin32 [required: >=300, installed: 306]
│   │   └── traitlets [required: >=5.3, installed: 5.14.1]
│   └── traitlets [required: >=5.1, installed: 5.14.1]
├── Sphinx [required: >=1.8, installed: 7.2.6]
│   ├── alabaster [required: >=0.7,<0.8, installed: 0.7.16]
│   ├── Babel [required: >=2.9, installed: 2.14.0]
│   ├── colorama [required: >=0.4.5, installed: 0.4.6]
│   ├── docutils [required: >=0.18.1,<0.21, installed: 0.20.1]
│   ├── imagesize [required: >=1.3, installed: 1.4.1]
│   ├── Jinja2 [required: >=3.0, installed: 3.1.3]
│   │   └── MarkupSafe [required: >=2.0, installed: 2.1.5]
│   ├── packaging [required: >=21.0, installed: 23.2]
│   ├── Pygments [required: >=2.14, installed: 2.17.2]
│   ├── requests [required: >=2.25.0, installed: 2.31.0]
│   │   ├── certifi [required: >=2017.4.17, installed: 2024.2.2]
│   │   ├── charset-normalizer [required: >=2,<4, installed: 3.3.2]
│   │   ├── idna [required: >=2.5,<4, installed: 3.6]
│   │   └── urllib3 [required: >=1.21.1,<3, installed: 2.2.1]
│   ├── snowballstemmer [required: >=2.0, installed: 2.2.0]
│   ├── sphinxcontrib-applehelp [required: Any, installed: 1.0.8]
│   ├── sphinxcontrib-devhelp [required: Any, installed: 1.0.6]
│   ├── sphinxcontrib-htmlhelp [required: >=2.0.0, installed: 2.0.5]
│   ├── sphinxcontrib-jsmath [required: Any, installed: 1.0.1]
│   ├── sphinxcontrib-qthelp [required: Any, installed: 1.0.7]
│   └── sphinxcontrib-serializinghtml [required: >=1.1.9, installed: 1.1.10]
└── traitlets [required: >=5, installed: 5.14.1]
pexpect==4.9.0
└── ptyprocess [required: >=0.5, installed: 0.7.0]
pipdeptree==2.16.2
└── pip [required: >=23.1.2, installed: 24.0]
pkginfo==1.9.6
pygls==1.3.1
├── cattrs [required: >=23.1.2, installed: 23.2.3]
│   └── attrs [required: >=23.1.0, installed: 23.2.0]
└── lsprotocol [required: ==2023.0.1, installed: 2023.0.1]
    ├── attrs [required: >=21.3.0, installed: 23.2.0]
    └── cattrs [required: !=23.2.1, installed: 23.2.3]
        └── attrs [required: >=23.1.0, installed: 23.2.0]
pylint==3.2.2
├── astroid [required: >=3.2.2,<=3.3.0-dev0, installed: 3.2.2]
├── colorama [required: >=0.4.5, installed: 0.4.6]
├── dill [required: >=0.3.6, installed: 0.3.8]
├── isort [required: >=4.2.5,<6,!=5.13.0, installed: 5.13.2]
├── mccabe [required: >=0.6,<0.8, installed: 0.7.0]
├── platformdirs [required: >=2.2.0, installed: 3.11.0]
└── tomlkit [required: >=0.10.1, installed: 0.12.3]
pyspellchecker==0.8.1
requests-toolbelt==1.0.0
└── requests [required: >=2.0.1,<3.0.0, installed: 2.31.0]
    ├── certifi [required: >=2017.4.17, installed: 2024.2.2]
    ├── charset-normalizer [required: >=2,<4, installed: 3.3.2]
    ├── idna [required: >=2.5,<4, installed: 3.6]
    └── urllib3 [required: >=1.21.1,<3, installed: 2.2.1]
restructuredtext_lint==1.4.0
└── docutils [required: >=0.11,<1.0, installed: 0.20.1]
rich==13.7.0
├── markdown-it-py [required: >=2.2.0, installed: 3.0.0]
│   └── mdurl [required: ~=0.1, installed: 0.1.2]
└── Pygments [required: >=2.13.0,<3.0.0, installed: 2.17.2]
scipy==1.12.0
└── numpy [required: >=1.22.4,<1.29.0, installed: 1.26.4]
setuptools==65.5.0
shellingham==1.5.4
sphinx-book-theme==1.1.2
├── pydata-sphinx-theme [required: >=0.14, installed: 0.15.2]
│   ├── accessible-pygments [required: Any, installed: 0.0.4]
│   │   └── Pygments [required: >=1.5, installed: 2.17.2]
│   ├── Babel [required: Any, installed: 2.14.0]
│   ├── beautifulsoup4 [required: Any, installed: 4.12.3]
│   │   └── soupsieve [required: >1.2, installed: 2.5]
│   ├── docutils [required: !=0.17.0, installed: 0.20.1]
│   ├── packaging [required: Any, installed: 23.2]
│   ├── Pygments [required: >=2.7, installed: 2.17.2]
│   ├── Sphinx [required: >=5.0, installed: 7.2.6]
│   │   ├── alabaster [required: >=0.7,<0.8, installed: 0.7.16]
│   │   ├── Babel [required: >=2.9, installed: 2.14.0]
│   │   ├── colorama [required: >=0.4.5, installed: 0.4.6]
│   │   ├── docutils [required: >=0.18.1,<0.21, installed: 0.20.1]
│   │   ├── imagesize [required: >=1.3, installed: 1.4.1]
│   │   ├── Jinja2 [required: >=3.0, installed: 3.1.3]
│   │   │   └── MarkupSafe [required: >=2.0, installed: 2.1.5]
│   │   ├── packaging [required: >=21.0, installed: 23.2]
│   │   ├── Pygments [required: >=2.14, installed: 2.17.2]
│   │   ├── requests [required: >=2.25.0, installed: 2.31.0]
│   │   │   ├── certifi [required: >=2017.4.17, installed: 2024.2.2]
│   │   │   ├── charset-normalizer [required: >=2,<4, installed: 3.3.2]
│   │   │   ├── idna [required: >=2.5,<4, installed: 3.6]
│   │   │   └── urllib3 [required: >=1.21.1,<3, installed: 2.2.1]
│   │   ├── snowballstemmer [required: >=2.0, installed: 2.2.0]
│   │   ├── sphinxcontrib-applehelp [required: Any, installed: 1.0.8]
│   │   ├── sphinxcontrib-devhelp [required: Any, installed: 1.0.6]
│   │   ├── sphinxcontrib-htmlhelp [required: >=2.0.0, installed: 2.0.5]
│   │   ├── sphinxcontrib-jsmath [required: Any, installed: 1.0.1]
│   │   ├── sphinxcontrib-qthelp [required: Any, installed: 1.0.7]
│   │   └── sphinxcontrib-serializinghtml [required: >=1.1.9, installed: 1.1.10]
│   └── typing_extensions [required: Any, installed: 4.9.0]
└── Sphinx [required: >=5, installed: 7.2.6]
    ├── alabaster [required: >=0.7,<0.8, installed: 0.7.16]
    ├── Babel [required: >=2.9, installed: 2.14.0]
    ├── colorama [required: >=0.4.5, installed: 0.4.6]
    ├── docutils [required: >=0.18.1,<0.21, installed: 0.20.1]
    ├── imagesize [required: >=1.3, installed: 1.4.1]
    ├── Jinja2 [required: >=3.0, installed: 3.1.3]
    │   └── MarkupSafe [required: >=2.0, installed: 2.1.5]
    ├── packaging [required: >=21.0, installed: 23.2]
    ├── Pygments [required: >=2.14, installed: 2.17.2]
    ├── requests [required: >=2.25.0, installed: 2.31.0]
    │   ├── certifi [required: >=2017.4.17, installed: 2024.2.2]
    │   ├── charset-normalizer [required: >=2,<4, installed: 3.3.2]
    │   ├── idna [required: >=2.5,<4, installed: 3.6]
    │   └── urllib3 [required: >=1.21.1,<3, installed: 2.2.1]
    ├── snowballstemmer [required: >=2.0, installed: 2.2.0]
    ├── sphinxcontrib-applehelp [required: Any, installed: 1.0.8]
    ├── sphinxcontrib-devhelp [required: Any, installed: 1.0.6]
    ├── sphinxcontrib-htmlhelp [required: >=2.0.0, installed: 2.0.5]
    ├── sphinxcontrib-jsmath [required: Any, installed: 1.0.1]
    ├── sphinxcontrib-qthelp [required: Any, installed: 1.0.7]
    └── sphinxcontrib-serializinghtml [required: >=1.1.9, installed: 1.1.10]
stevedore==5.2.0
└── pbr [required: >=2.0.0,!=2.1.0, installed: 6.0.0]
trove-classifiers==2024.1.31
virtualenv==20.25.1
├── distlib [required: >=0.3.7,<1, installed: 0.3.8]
├── filelock [required: >=3.12.2,<4, installed: 3.13.1]
└── platformdirs [required: >=3.9.1,<5, installed: 3.11.0]

[kemzeb]

Just "pipdeptree" does exactly what?

This will grab all the package metadata from your system environment and render it as text (as that is the default rendering option). If you want to just see your package in the result, you can pass the -p mypackage option. If you are working in a virtual environment, you may pass either the path to that environment's interpreter (e.g. --python /path/to/interpreter/python) or you can pass --python auto if your virtual environment is activated so that it can be automatically detected.

Why is numpy not listed by pipdeptree.

This is because when pipdeptree detects it as a dependency, it will only be included as part of that package's dependencies (so not as a top-level package). We can see this in your output e.g.:

matplotlib==3.8.3
├── contourpy [required: >=1.0.1, installed: 1.2.0]
│   └── numpy [required: >=1.20,<2.0, installed: 1.26.4] # <--- Here
├── cycler [required: >=0.10, installed: 0.12.1]
├── fonttools [required: >=4.22.0, installed: 4.49.0]
├── kiwisolver [required: >=1.3.1, installed: 1.4.5]
├── numpy [required: >=1.21,<2, installed: 1.26.4] # <-- Here
├── packaging [required: >=20.0, installed: 23.2]
├── pillow [required: >=8, installed: 10.2.0]
├── pyparsing [required: >=2.3.1, installed: 3.1.1]
└── python-dateutil [required: >=2.7, installed: 2.8.2]
    └── six [required: >=1.5, installed: 1.16.0]

If you want to see numpy as a top-level package (and in effect all other dependencies), you can pass the -a or --all option.

[sandeep026]

@kemzeb thanks for clarifying. I am developing and testing a package right now (not yet packaged). I include in scripts by doing the following. How do I display mmpl's dependencies?

import casadi as cs
import sys
sys.path.append(r"C:\Users\Documents\noc\mmpl")
import mmpl  # NOQA

[kemzeb]

From looking at your code snippet, it looks like you are modifying sys.path during runtime in order for the importing mechanism to be able to find mmpl. More importantly, it seems that mmpl is not already available in your environment.

One approach to see mmpl deps is to use Python's $PYTHONPATH environment variable like:

PYTHONPATH="C:\Users\Documents\noc\mmpl" pipdeptree -p mmpl

Note that pipdeptree analyzes the package metadata. So if mmpl doesn't have a metadata directory or your path doesn't point to a directory that contains mmpl's metadata directory, it cannot be displayed.

[sandeep026]

I assume you refer to the setup.py/toml file which will be used by pipdeptree to list dependencies as metadata.

So given the metadata only, pipdeptree utilizes this to display dependency trees. So, it can be used with already packaged projects.

In my case, I want to have a program which can detect all the dependencies while running a script or given the path to package folder which may or may not contain the metadata.

Thanks for the above explainations.