From b9874cc7edadccad037f6db5289d0681f1c482e4 Mon Sep 17 00:00:00 2001 From: Virgil Dupras Date: Tue, 5 Jan 2016 17:14:05 -0500 Subject: [PATCH] Add tox instructions in README Also, remove py33 from tox envlist --- README.md | 14 ++++++++++++++ tox.ini | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dd414f16..9fde2e95 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,18 @@ You can also package dupeGuru into an installable package with: $ python package.py +# Running tests + +The complete test suite is ran with [Tox 1.7+][tox]. If you have it installed system-wide, you +don't even need to set up a virtualenv. Just `cd` into the root project folder and run `tox`. + +If you don't have Tox system-wide, install it in your virtualenv with `pip install tox` and then +run `tox`. + +You can also run automated tests without Tox. Extra requirements for running tests are in +`requirements-extra.txt`. So, you can do `pip install -r requirements-extra.txt` inside your +virtualenv and then `py.test core hscommon` + [dupeguru]: http://www.hardcoded.net/dupeguru/ [cross-toolkit]: http://www.hardcoded.net/articles/cross-toolkit-software [contrib-issue]: https://github.com/hsoft/dupeguru/issues/300 @@ -145,3 +157,5 @@ You can also package dupeGuru into an installable package with: [cxfreeze]: http://cx-freeze.sourceforge.net/ [advinst]: http://www.advancedinstaller.com [pyenv]: https://github.com/yyuu/pyenv +[tox]: https://tox.readthedocs.org/en/latest/ + diff --git a/tox.ini b/tox.ini index 352b24c1..b115a939 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py33,py34 +envlist = py34 skipsdist = True [testenv]