PIPDEPTREE(1)

πŸ’– PIPDEPTREE(1) πŸ’–

okay bestie, listen up β€” this is the manual page for pipdeptree, a User Commands legend, and I'm about to walk you through it like we're texting at 1am. it shows you the dependency tree of your installed Python packages. yes, that dependency tree. the one you've been ignoring. sit down, hydrate, let's go 🫢


🌸 NAME 🌸

pipdeptree β€” display dependency tree of the installed Python 3 packages, and also display dependency tree of the installed Python packages. (yes it says both, it's an overachiever, we love that for it πŸ’…)


✨ SYNOPSIS ✨

pipdeptree [-h] [-v] [-f] [-a] [-l] [-u] [-w [{silence,suppress,fail}]]
[-r] [-p PACKAGES] [-e PACKAGES] [-j] [--json-tree] [--graph-output
OUTPUT_FORMAT]

look at all those flags. it's giving main character energy, no cap πŸ‘‘


πŸ¦‹ DESCRIPTION πŸ¦‹

Dependency tree of the installed python packages. that's the whole vibe. it looks at what you've got installed and maps out who needs who, like a group chat drama diagram but for Python imports πŸ“


πŸ’œ OPTIONS πŸ’œ

πŸŽ€ optional arguments:

  • -h, --help β€” show this help message and exit. the classic. the moment you forget a flag, this is your bestie fr fr πŸ™ˆ
  • -v, --version β€” show program's version number and exit. quick lil identity check ✨
  • -f, --freeze β€” Print names so as to write freeze files. you know, for when you need that requirements.txt energy 🧊
  • -a, --all β€” list all deps at top level. everything. all of it. no hiding 🌈
  • -l, --local-only β€” If in a virtualenv that has global access do not show globally installed packages. stay in your lane, venv πŸ’…
  • -u, --user-only β€” Only show installations in the user site dir. just the user-y ones πŸŽ€
  • -w [{silence,suppress,fail}], --warn [{silence,suppress,fail}] β€” Warning control. okay so this one has lore, let me break it down:
    • "suppress" will show warnings but return 0 whether or not they are present. (this is the default, bestie β€” that's the one you get if you say nothing at all)
    • "silence" will not show warnings at all and always return 0. zero warnings, zero thoughts, iconic 😌
    • "fail" will show warnings and return 1 if any are present. the dramatic one. it WILL be messy about it πŸ’€

The default is "suppress".

  • -r, --reverse β€” Shows the dependency tree in the reverse fashion ie. the sub-dependencies are listed with the list of packages that need them under them. flip the whole thing around, turn the map upside down πŸ¦‹
  • -p PACKAGES, --packages PACKAGES β€” Comma separated list of select packages to show in the output. If set, --all will be ignored. you want these specific ones? okay. but just so you know, --all gets ghosted when you do this πŸ‘»
  • -e PACKAGES, --exclude PACKAGES β€” Comma separated list of select packages to exclude from the output. If set, --all will be ignored. same deal, but this time you're kicking them out of the group chat πŸšͺ and yeah, --all gets ignored here too.
  • -j, --json β€” Display dependency tree as json. This will yield "raw" output that may be used by external tools. This option overrides all other options. it's the "I'm not like other flags" flag. it overrides EVERYTHING πŸ”₯
  • --json-tree β€” Display dependency tree as json which is nested the same way as the plain text output printed by default. This option overrides all other options (except --json). so it's the boss of everyone... except --json. the hierarchy is real πŸ‘‘
  • --graph-output OUTPUT_FORMAT β€” Print a dependency graph in the specified output format. Available are all formats supported by GraphViz, e.g.: dot, jpeg, pdf, png, svg. pretty pictures!! aesthetic dependency trees!! we love a visual 🌸

🫢 AUTHOR 🫢

This manpage was written by Andreas Tille for the Debian distribution and can be used for any other usage of the program. king behaviour, honestly πŸ‘‘


⚠️ real talk though: that --json override is a big deal β€” it eats every other option on the list. and remember -w defaults to "suppress", so if you're out here expecting warnings to blow up your exit code and they don't? that's why, bestie 😭

and that's the whole page!! this was pipdeptree version 0.13.0, dated August 2018, and it's still serving looks. stay hydrated, read your dependency trees, and don't let --all catch you ignoring it πŸ’–βœ¨πŸ¦‹πŸŽ€πŸ’