aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorSVN-Git Migration <python-modules-team@lists.alioth.debian.org>2015-10-08 13:19:35 -0700
committerSVN-Git Migration <python-modules-team@lists.alioth.debian.org>2015-10-08 13:19:35 -0700
commit52980ebd0a4eb75acf055a2256e095772c1fa7c6 (patch)
treef339a7e66934caa7948c15e8c5bd3ea04ee72e5a /README.rst
parent92b84b67f7b187b81dacbf1ae46d59a1d0b5b125 (diff)
downloadpython-urllib3-52980ebd0a4eb75acf055a2256e095772c1fa7c6.tar
python-urllib3-52980ebd0a4eb75acf055a2256e095772c1fa7c6.tar.gz
Imported Upstream version 1.7.1
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index 75f05d8..b126647 100644
--- a/README.rst
+++ b/README.rst
@@ -17,7 +17,7 @@ Highlights
- Supports gzip and deflate decoding.
- Thread-safe and sanity-safe.
- Works with AppEngine, gevent, and eventlib.
-- Tested on Python 2.6+ and Python 3.3+, 100% unit test coverage.
+- Tested on Python 2.6+ and Python 3.2+, 100% unit test coverage.
- Small and easy to understand codebase perfect for extending and building upon.
For a more comprehensive solution, have a look at
`Requests <http://python-requests.org/>`_ which is also powered by urllib3.
@@ -81,14 +81,18 @@ pools, you should look at
Run the tests
=============
-We use some external dependencies to run the urllib3 test suite. Easiest way to
-run the tests is thusly from the urllib3 source root: ::
+We use some external dependencies, multiple interpreters and code coverage
+analysis while running test suite. Easiest way to run the tests is thusly the
+``tox`` utility: ::
- $ pip install -r test-requirements.txt
- $ nosetests
- .....................................................
+ $ tox
+ # [..]
+ py26: commands succeeded
+ py27: commands succeeded
+ py32: commands succeeded
+ py33: commands succeeded
-Success! You could also ``pip install coverage`` to get code coverage reporting.
+Note that code coverage less than 100% is regarded as a failing run.
Contributing