From d0e6f9c047247667abd1850bb67b9c3ed68cb7e3 Mon Sep 17 00:00:00 2001 From: Kevin McCarthy Date: Sun, 9 Feb 2014 08:48:34 -1000 Subject: [PATCH] Add note to README about tox usage --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 7749483..562276e 100644 --- a/README.md +++ b/README.md @@ -263,6 +263,14 @@ VCR.py is a package on PyPI, so you can `pip install vcrpy` (first you may need I'm not trying to match the format of the Ruby VCR YAML files. Cassettes generated by Ruby's VCR are not compatible with VCR.py. +##Running VCR's test suite + +The tests are all run automatically on Travis, but you can also run them yourself using py.test and Tox. Tox will automatically run them in all environments VCR.py supports. The test suite is pretty big and slow, but you can tell tox to only run specific tests like this: + +`tox -e py27requests -- -v -k "'test_status_code or test_gzip'"` + +This will run only tests that look like `test_status_code` or `test_gzip` in the test suite, and only in the python 2.7 environment that has requests installed. + ##Known Issues This library is a work in progress, so the API might change on you. There are probably some [bugs](https://github.com/kevin1024/vcrpy/issues?labels=bug&page=1&state=open) floating around too.