DESCRIPTION.rst 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  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| |commits-since|
  10. | |saythanks|
  11. | |codesponsor|
  12. .. downloads badge seems to be broken... |downloads|
  13. Coverage.py measures code coverage, typically during test execution. It uses
  14. the code analysis tools and tracing hooks provided in the Python standard
  15. library to determine which lines are executable, and which have been executed.
  16. Coverage.py runs on many versions of Python:
  17. * CPython 2.6, 2.7 and 3.3 through 3.7.
  18. * PyPy2 5.6 and PyPy3 5.5.
  19. * Jython 2.7.1, though not for reporting.
  20. * IronPython 2.7.7, though not for reporting.
  21. Documentation is on `Read the Docs`_. Code repository and issue tracker are on
  22. `Bitbucket`_, with a mirrored repository on `GitHub`_.
  23. .. _Read the Docs: https://coverage.readthedocs.io
  24. .. _Bitbucket: https://bitbucket.org/ned/coveragepy
  25. .. _GitHub: https://github.com/nedbat/coveragepy
  26. **New in 4.4:** Suppressable warnings, continuous coverage measurement.
  27. New in 4.3: HTML ``--skip-covered``, sys.excepthook support, tox.ini
  28. support.
  29. New in 4.2: better support for multiprocessing and combining data.
  30. New in 4.1: much-improved branch coverage.
  31. New in 4.0: ``--concurrency``, plugins for non-Python files, setup.cfg
  32. support, --skip-covered, HTML filtering, and more than 50 issues closed.
  33. Getting Started
  34. ---------------
  35. See the `Quick Start section`_ of the docs.
  36. .. _Quick Start section: https://coverage.readthedocs.io/#quick-start
  37. Contributing
  38. ------------
  39. See the `Contributing section`_ of the docs.
  40. .. _Contributing section: https://coverage.readthedocs.io/en/latest/contributing.html
  41. License
  42. -------
  43. Licensed under the `Apache 2.0 License`_. For details, see `NOTICE.txt`_.
  44. .. _Apache 2.0 License: http://www.apache.org/licenses/LICENSE-2.0
  45. .. _NOTICE.txt: https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt
  46. .. |ci-status| image:: https://travis-ci.org/nedbat/coveragepy.svg?branch=master
  47. :target: https://travis-ci.org/nedbat/coveragepy
  48. :alt: Build status
  49. .. |win-ci-status| image:: https://ci.appveyor.com/api/projects/status/kmeqpdje7h9r6vsf/branch/master?svg=true
  50. :target: https://ci.appveyor.com/project/nedbat/coveragepy
  51. :alt: Windows build status
  52. .. |docs| image:: https://readthedocs.org/projects/coverage/badge/?version=latest&style=flat
  53. :target: https://coverage.readthedocs.io
  54. :alt: Documentation
  55. .. |reqs| image:: https://requires.io/github/nedbat/coveragepy/requirements.svg?branch=master
  56. :target: https://requires.io/github/nedbat/coveragepy/requirements/?branch=master
  57. :alt: Requirements status
  58. .. |kit| image:: https://badge.fury.io/py/coverage.svg
  59. :target: https://pypi.python.org/pypi/coverage
  60. :alt: PyPI status
  61. .. |format| image:: https://img.shields.io/pypi/format/coverage.svg
  62. :target: https://pypi.python.org/pypi/coverage
  63. :alt: Kit format
  64. .. |downloads| image:: https://img.shields.io/pypi/dw/coverage.svg
  65. :target: https://pypi.python.org/pypi/coverage
  66. :alt: Weekly PyPI downloads
  67. .. |versions| image:: https://img.shields.io/pypi/pyversions/coverage.svg
  68. :target: https://pypi.python.org/pypi/coverage
  69. :alt: Python versions supported
  70. .. |status| image:: https://img.shields.io/pypi/status/coverage.svg
  71. :target: https://pypi.python.org/pypi/coverage
  72. :alt: Package stability
  73. .. |license| image:: https://img.shields.io/pypi/l/coverage.svg
  74. :target: https://pypi.python.org/pypi/coverage
  75. :alt: License
  76. .. |codecov| image:: http://codecov.io/github/nedbat/coveragepy/coverage.svg?branch=master&precision=2
  77. :target: http://codecov.io/github/nedbat/coveragepy?branch=master
  78. :alt: Coverage!
  79. .. |commits-since| image:: https://img.shields.io/github/commits-since/nedbat/coveragepy/coverage-4.4.2.svg
  80. :target: https://github.com/nedbat/coveragepy/compare/coverage-4.4.2...master
  81. :alt: See latest work
  82. .. |saythanks| image:: https://img.shields.io/badge/saythanks.io-%E2%98%BC-1EAEDB.svg
  83. :target: https://saythanks.io/to/nedbat
  84. :alt: Say thanks :)
  85. .. |codesponsor| image:: https://app.codesponsor.io/embed/8cXmdZx1a9Mu45zuTzC5du75/nedbat/coveragepy.svg
  86. :target: https://app.codesponsor.io/link/8cXmdZx1a9Mu45zuTzC5du75/nedbat/coveragepy
  87. :height: 68px
  88. :width: 888px
  89. :alt: codesponsor.io