diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2015-08-29 17:57:49 -0400 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2015-08-29 17:57:49 -0400 |
commit | e56f2a9c30b637fc255b59740b9215f4b6b6c7f5 (patch) | |
tree | a3808c8f4415cd21cc7b2b0298740f890d208f3f /README.rst | |
parent | c09493c3ac0c45af24b44e976a01afcabc71ad47 (diff) | |
download | python-coveragepy-e56f2a9c30b637fc255b59740b9215f4b6b6c7f5.tar.gz |
Use README.rst instead of README.txt
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b385cc5 --- /dev/null +++ b/README.rst @@ -0,0 +1,44 @@ +=========== +Coverage.py +=========== + +Code coverage testing for Python. + +|ci-status| |win-ci-status| |docs| + +Coverage.py measures code coverage, typically during test execution. It uses +the code analysis tools and tracing hooks provided in the Python standard +library to determine which lines are executable, and which have been executed. + +Coverage.py runs on CPython 2.6, 2.7, 3.3, 3.4 or 3.5, PyPy 2.4, and PyPy3 2.4. + +Documentation is on `Read the Docs <http://coverage.readthedocs.org>`_. +Code repository and issue tracker are on `Bitbucket <http://bitbucket.org/ned/coveragepy>`_, +with a mirrored repository on `GitHub <https://github.com/nedbat/coveragepy>`_. + +**New in 4.0:** ``--concurrency``, plugins for other file variants, setup.cfg +support, --skip-covered, HTML filtering, and more than 50 issues closed. + + +Quick Start +----------- + +See the `quick start <http://coverage.readthedocs.org/#quick-start>`_ +section of the docs. + + +License +------- + +Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0. +For details, see https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt. + +.. |ci-status| image:: https://api.travis-ci.org/nedbat/coveragepy.svg?branch=master&style=flat + :target: https://travis-ci.org/nedbat/coveragepy + :alt: build status +.. |win-ci-status| image:: https://ci.appveyor.com/api/projects/status/bitbucket/ned/coveragepy?svg=true + :target: https://ci.appveyor.com/project/nedbat/coveragepy + :alt: Windows build status +.. |docs| image:: https://readthedocs.org/projects/coverage/badge/?version=latest&style=flat + :target: http://coverage.readthedocs.org + :alt: Documentation |