From ba9376eca9c05fda52a532af84c8d00eeb8e919d Mon Sep 17 00:00:00 2001 From: Vineet Date: Sun, 2 Feb 2014 23:28:10 +0530 Subject: [PATCH] Update README with comparison with pip freeze --- README.rst | 55 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 48 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 933fa42..781e8c4 100644 --- a/README.rst +++ b/README.rst @@ -1,14 +1,59 @@ pipdeptree ========== -A command line utility to show the installed packages as a dependency -tree. +`pipdeptree` is a command line utility to show the installed python +packages as a dependency tree. It works pretty much like `pip +freeze`. Since `pip freeze` shows all dependencies as a flat list, +finding out which are the top level packages and which packages do +they depend on requires some effort. This utility tries to solve this +problem. + +To give you a brief idea here is the output of `pipdeptree` compared +to `pip freeze` + +.. source-code:: bash + + $ pip freeze + Flask==0.10.1 + Flask-Script==0.6.6 + Jinja2==2.7.2 + Mako==0.9.1 + MarkupSafe==0.18 + SQLAlchemy==0.9.1 + Werkzeug==0.9.4 + alembic==0.6.2 + argparse==1.2.1 + itsdangerous==0.23 + psycopg2==2.5.2 + redis==2.9.1 + slugify==0.0.1 + wsgiref==0.1.2 + +.. source-code:: bash + + $ python pipdeptree.py + wsgiref==0.1.2 + argparse==1.2.1 + psycopg2==2.5.2 + flask-script==0.6.6 + - flask [installed: 0.10.1] + - werkzeug [required: >=0.7, installed: 0.9.4] + - jinja2 [required: >=2.4, installed: 2.7.2] + - markupsafe [installed: 0.18] + - itsdangerous [required: >=0.21, installed: 0.23] + alembic==0.6.2 + - sqlalchemy [required: >=0.7.3, installed: 0.9.1] + - mako [installed: 0.9.1] + - markupsafe [required: >=0.9.2, installed: 0.18] + slugify==0.0.1 + redis==2.9.1 Installation ------------ -:todo +This library is still being worked upon and hence, yet to be published +on pypi Usage @@ -21,7 +66,3 @@ License ------- MIT - - - -