Merge pull request #88 from cointoss1973/documents
Supports README version 0.10.1
This commit is contained in:
commit
6f70dd5508
63
README.rst
63
README.rst
|
@ -97,7 +97,7 @@ with `--packages` flag as follows:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
$ python pipdeptree.py --reverse --packages itsdangerous,gnureadline
|
$ pipdeptree --reverse --packages itsdangerous,gnureadline
|
||||||
gnureadline==6.3.3
|
gnureadline==6.3.3
|
||||||
- ipython==2.0.0 [requires: gnureadline]
|
- ipython==2.0.0 [requires: gnureadline]
|
||||||
itsdangerous==0.24
|
itsdangerous==0.24
|
||||||
|
@ -205,7 +205,7 @@ tools.
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
$ python pipdeptree.py --json
|
$ pipdeptree --json
|
||||||
|
|
||||||
The dependency graph can be layed out as any of the formats supported by
|
The dependency graph can be layed out as any of the formats supported by
|
||||||
`GraphViz <http://www.graphviz.org/>`_:
|
`GraphViz <http://www.graphviz.org/>`_:
|
||||||
|
@ -223,37 +223,38 @@ Usage
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
usage: pipdeptree.py [-h] [-f] [-a] [-l] [-w [{silence,suppress,fail}]] [-r]
|
usage: pipdeptree [-h] [-v] [-f] [-a] [-l] [-u] [-w [{silence,suppress,fail}]]
|
||||||
[-p PACKAGES] [-j]
|
[-r] [-p PACKAGES] [-j] [--graph-output OUTPUT_FORMAT]
|
||||||
|
|
||||||
Dependency tree of the installed python packages
|
Dependency tree of the installed python packages
|
||||||
|
|
||||||
optional arguments:
|
optional arguments:
|
||||||
-h, --help show this help message and exit
|
-h, --help show this help message and exit
|
||||||
-f, --freeze Print names so as to write freeze files
|
-v, --version show program's version number and exit
|
||||||
-a, --all list all deps at top level
|
-f, --freeze Print names so as to write freeze files
|
||||||
-l, --local-only If in a virtualenv that has global access do not show
|
-a, --all list all deps at top level
|
||||||
globally installed packages
|
-l, --local-only If in a virtualenv that has global access do not show
|
||||||
-u, --user-only Only show installations in the user site dir
|
globally installed packages
|
||||||
-w [{silence,suppress,fail}], --warn [{silence,suppress,fail}]
|
-u, --user-only Only show installations in the user site dir
|
||||||
Warning control. "suppress" will show warnings but
|
-w [{silence,suppress,fail}], --warn [{silence,suppress,fail}]
|
||||||
return 0 whether or not they are present. "silence"
|
Warning control. "suppress" will show warnings but
|
||||||
will not show warnings at all and always return 0.
|
return 0 whether or not they are present. "silence"
|
||||||
"fail" will show warnings and return 1 if any are
|
will not show warnings at all and always return 0.
|
||||||
present. The default is "suppress".
|
"fail" will show warnings and return 1 if any are
|
||||||
-r, --reverse Shows the dependency tree in the reverse fashion ie.
|
present. The default is "suppress".
|
||||||
the sub-dependencies are listed with the list of
|
-r, --reverse Shows the dependency tree in the reverse fashion ie.
|
||||||
packages that need them under them.
|
the sub-dependencies are listed with the list of
|
||||||
-p PACKAGES, --packages PACKAGES
|
packages that need them under them.
|
||||||
Comma separated list of select packages to show in the
|
-p PACKAGES, --packages PACKAGES
|
||||||
output. If set, --all will be ignored.
|
Comma separated list of select packages to show in the
|
||||||
-j, --json Display dependency tree as json. This will yield "raw"
|
output. If set, --all will be ignored.
|
||||||
output that may be used by external tools. This option
|
-j, --json Display dependency tree as json. This will yield "raw"
|
||||||
overrides all other options.
|
output that may be used by external tools. This option
|
||||||
--graph-output OUTPUT_FORMAT
|
overrides all other options.
|
||||||
Print a dependency graph in the specified output
|
--graph-output OUTPUT_FORMAT
|
||||||
format. Available are all formats supported by
|
Print a dependency graph in the specified output
|
||||||
GraphViz, e.g.: dot, jpeg, pdf, png, svg
|
format. Available are all formats supported by
|
||||||
|
GraphViz, e.g.: dot, jpeg, pdf, png, svg
|
||||||
|
|
||||||
|
|
||||||
Known Issues
|
Known Issues
|
||||||
|
|
Loading…
Reference in New Issue