From 07685bd31327d8ed2f04d9e1e5c9f95f9718c8b2 Mon Sep 17 00:00:00 2001 From: Vineet Naik Date: Mon, 3 Aug 2015 22:06:30 +0530 Subject: [PATCH] Update README - Update the section on running tests - Add travis-ci badge --- README.rst | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 67f2f6b..3d03b33 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,10 @@ pipdeptree ========== +.. image:: https://travis-ci.org/naiquevin/pipdeptree.svg?branch=master + :target: https://travis-ci.org/naiquevin/pipdeptree + + ``pipdeptree`` is a command line utility for displaying the python packages installed in an virtualenv in form of a dependency tree. Since ``pip freeze`` shows all dependencies as a flat list, @@ -196,22 +200,30 @@ Known Issues Runnings Tests (for contributors) --------------------------------- -Tests require some dummy virtualenvs to be created. If you run them -using `tox `_, then that will -take care of creating the virtualenvs, so it's recommended that you -run the tests using ``tox`` for the first time. +Tests can be run against all version of python using `tox +`_ as follows: .. code-block:: bash - $ pip install tox - $ tox + $ make test-tox -Thereafter, you may use either `pytest `_ -or `nose `_ to run them. +This assumes that you have python versions 2.6, 2.7, 3.2, 3.3 and 3.4 +installed on your machine. (See more: tox.ini) -However, before pushing the code or sending pull requests it's -recommended to run ``tox`` once so that tests are run on all -environments. +Or if you don't want to install all the versions of python but want to +run tests quickly against Python2.7 only: + +.. code-block:: bash + + $ make test + +Tests require some virtualenvs to be created, so another assumption is +that you have ``virtualenv`` installed. + +Before pushing the code or sending pull requests it's recommended to +run ``make test-tox`` once so that tests are run on all environments. + +(See more: Makefile) License