README.rst 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. .. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
  2. .. For details: https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt
  3. ===========
  4. Coverage.py
  5. ===========
  6. Code coverage testing for Python.
  7. | |license| |versions| |status| |docs|
  8. | |ci-status| |win-ci-status| |codecov|
  9. | |kit| |format| |downloads|
  10. Coverage.py measures code coverage, typically during test execution. It uses
  11. the code analysis tools and tracing hooks provided in the Python standard
  12. library to determine which lines are executable, and which have been executed.
  13. Coverage.py runs on CPython 2.6, 2.7, and 3.3 through 3.6; PyPy 4.0 and 5.1;
  14. and PyPy3 2.4.
  15. Documentation is on `Read the Docs <http://coverage.readthedocs.io>`_.
  16. Code repository and issue tracker are on `Bitbucket <http://bitbucket.org/ned/coveragepy>`_,
  17. with a mirrored repository on `GitHub <https://github.com/nedbat/coveragepy>`_.
  18. **New in 4.2:** better support for multiprocessing and combining data.
  19. New in 4.1: much-improved branch coverage.
  20. New in 4.0: ``--concurrency``, plugins for non-Python files, setup.cfg
  21. support, --skip-covered, HTML filtering, and more than 50 issues closed.
  22. Getting Started
  23. ---------------
  24. See the `quick start <http://coverage.readthedocs.io/#quick-start>`_
  25. section of the docs.
  26. License
  27. -------
  28. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0.
  29. For details, see https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt.
  30. .. |ci-status| image:: https://travis-ci.org/nedbat/coveragepy.svg?branch=master
  31. :target: https://travis-ci.org/nedbat/coveragepy
  32. :alt: Build status
  33. .. |win-ci-status| image:: https://ci.appveyor.com/api/projects/status/bitbucket/ned/coveragepy?svg=true
  34. :target: https://ci.appveyor.com/project/nedbat/coveragepy
  35. :alt: Windows build status
  36. .. |docs| image:: https://readthedocs.org/projects/coverage/badge/?version=latest&style=flat
  37. :target: http://coverage.readthedocs.io
  38. :alt: Documentation
  39. .. |reqs| image:: https://requires.io/github/nedbat/coveragepy/requirements.svg?branch=master
  40. :target: https://requires.io/github/nedbat/coveragepy/requirements/?branch=master
  41. :alt: Requirements status
  42. .. |kit| image:: https://badge.fury.io/py/coverage.svg
  43. :target: https://pypi.python.org/pypi/coverage
  44. :alt: PyPI status
  45. .. |format| image:: https://img.shields.io/pypi/format/coverage.svg
  46. :target: https://pypi.python.org/pypi/coverage
  47. :alt: Kit format
  48. .. |downloads| image:: https://img.shields.io/pypi/dw/coverage.svg
  49. :target: https://pypi.python.org/pypi/coverage
  50. :alt: Weekly PyPI downloads
  51. .. |versions| image:: https://img.shields.io/pypi/pyversions/coverage.svg
  52. :target: https://pypi.python.org/pypi/coverage
  53. :alt: Python versions supported
  54. .. |status| image:: https://img.shields.io/pypi/status/coverage.svg
  55. :target: https://pypi.python.org/pypi/coverage
  56. :alt: Package stability
  57. .. |license| image:: https://img.shields.io/pypi/l/coverage.svg
  58. :target: https://pypi.python.org/pypi/coverage
  59. :alt: License
  60. .. |codecov| image:: http://codecov.io/github/nedbat/coveragepy/coverage.svg?branch=master
  61. :target: http://codecov.io/github/nedbat/coveragepy?branch=master
  62. :alt: Coverage!