diff --git a/README.rst b/README.rst index d6eaf36..4b15043 100644 --- a/README.rst +++ b/README.rst @@ -97,7 +97,7 @@ with `--packages` flag as follows: .. code-block:: bash - $ python pipdeptree.py --reverse --packages itsdangerous,gnureadline + $ pipdeptree --reverse --packages itsdangerous,gnureadline gnureadline==6.3.3 - ipython==2.0.0 [requires: gnureadline] itsdangerous==0.24 @@ -205,7 +205,7 @@ tools. .. code-block:: bash - $ python pipdeptree.py --json + $ pipdeptree --json The dependency graph can be layed out as any of the formats supported by `GraphViz `_: @@ -223,37 +223,38 @@ Usage .. code-block:: bash - usage: pipdeptree.py [-h] [-f] [-a] [-l] [-w [{silence,suppress,fail}]] [-r] - [-p PACKAGES] [-j] + usage: pipdeptree [-h] [-v] [-f] [-a] [-l] [-u] [-w [{silence,suppress,fail}]] + [-r] [-p PACKAGES] [-j] [--graph-output OUTPUT_FORMAT] - Dependency tree of the installed python packages + Dependency tree of the installed python packages - optional arguments: - -h, --help show this help message and exit - -f, --freeze Print names so as to write freeze files - -a, --all list all deps at top level - -l, --local-only If in a virtualenv that has global access do not show - globally installed packages - -u, --user-only Only show installations in the user site dir - -w [{silence,suppress,fail}], --warn [{silence,suppress,fail}] - Warning control. "suppress" will show warnings but - return 0 whether or not they are present. "silence" - will not show warnings at all and always return 0. - "fail" will show warnings and return 1 if any are - present. 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. - -p PACKAGES, --packages PACKAGES - Comma separated list of select packages to show in the - output. If set, --all will be ignored. - -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. - --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 + optional arguments: + -h, --help show this help message and exit + -v, --version show program's version number and exit + -f, --freeze Print names so as to write freeze files + -a, --all list all deps at top level + -l, --local-only If in a virtualenv that has global access do not show + globally installed packages + -u, --user-only Only show installations in the user site dir + -w [{silence,suppress,fail}], --warn [{silence,suppress,fail}] + Warning control. "suppress" will show warnings but + return 0 whether or not they are present. "silence" + will not show warnings at all and always return 0. + "fail" will show warnings and return 1 if any are + present. 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. + -p PACKAGES, --packages PACKAGES + Comma separated list of select packages to show in the + output. If set, --all will be ignored. + -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. + --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 Known Issues