6 =========== |
6 =========== |
7 |
7 |
8 Code coverage testing for Python. |
8 Code coverage testing for Python. |
9 |
9 |
10 | |license| |versions| |status| |
10 | |license| |versions| |status| |
11 | |ci-status| |win-ci-status| |docs| |codecov| |
11 | |ci-status| |docs| |codecov| |
12 | |kit| |format| |repos| |
12 | |kit| |format| |repos| |downloads| |
13 | |stars| |forks| |contributors| |
13 | |stars| |forks| |contributors| |
14 | |tidelift| |twitter-coveragepy| |twitter-nedbat| |
14 | |tidelift| |twitter-coveragepy| |twitter-nedbat| |
15 |
15 |
16 Coverage.py measures code coverage, typically during test execution. It uses |
16 Coverage.py measures code coverage, typically during test execution. It uses |
17 the code analysis tools and tracing hooks provided in the Python standard |
17 the code analysis tools and tracing hooks provided in the Python standard |
18 library to determine which lines are executable, and which have been executed. |
18 library to determine which lines are executable, and which have been executed. |
19 |
19 |
20 Coverage.py runs on many versions of Python: |
20 Coverage.py runs on many versions of Python: |
21 |
21 |
22 * CPython 2.7. |
22 * CPython 2.7. |
23 * CPython 3.5 through 3.9 alpha 2. |
23 * CPython 3.5 through 3.10 alpha. |
24 * PyPy2 7.0 and PyPy3 7.0. |
24 * PyPy2 7.3.1 and PyPy3 7.3.1. |
25 |
25 |
26 Documentation is on `Read the Docs`_. Code repository and issue tracker are on |
26 Documentation is on `Read the Docs`_. Code repository and issue tracker are on |
27 `GitHub`_. |
27 `GitHub`_. |
28 |
28 |
29 .. _Read the Docs: https://coverage.readthedocs.io/ |
29 .. _Read the Docs: https://coverage.readthedocs.io/ |
30 .. _GitHub: https://github.com/nedbat/coveragepy |
30 .. _GitHub: https://github.com/nedbat/coveragepy |
31 |
31 |
32 |
32 |
33 **New in 5.0:** SQLite data storage, JSON report, contexts, relative filenames, |
33 **New in 5.x:** SQLite data storage, JSON report, contexts, relative filenames, |
34 dropped support for Python 2.6, 3.3 and 3.4. |
34 dropped support for Python 2.6, 3.3 and 3.4. |
35 |
35 |
36 |
36 |
37 For Enterprise |
37 For Enterprise |
38 -------------- |
38 -------------- |
39 |
39 |
40 .. |tideliftlogo| image:: https://nedbatchelder.com/pix/Tidelift_Logo_small.png |
40 .. |tideliftlogo| image:: https://nedbatchelder.com/pix/Tidelift_Logo_small.png |
41 :width: 75 |
|
42 :alt: Tidelift |
41 :alt: Tidelift |
43 :target: https://tidelift.com/subscription/pkg/pypi-coverage?utm_source=pypi-coverage&utm_medium=referral&utm_campaign=readme |
42 :target: https://tidelift.com/subscription/pkg/pypi-coverage?utm_source=pypi-coverage&utm_medium=referral&utm_campaign=readme |
44 |
43 |
45 .. list-table:: |
44 .. list-table:: |
46 :widths: 10 100 |
45 :widths: 10 100 |
94 |
93 |
95 .. _Apache 2.0 License: http://www.apache.org/licenses/LICENSE-2.0 |
94 .. _Apache 2.0 License: http://www.apache.org/licenses/LICENSE-2.0 |
96 .. _NOTICE.txt: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt |
95 .. _NOTICE.txt: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt |
97 |
96 |
98 |
97 |
99 .. |ci-status| image:: https://travis-ci.com/nedbat/coveragepy.svg?branch=master |
98 .. |ci-status| image:: https://github.com/nedbat/coveragepy/workflows/Test%20Suite/badge.svg |
100 :target: https://travis-ci.com/nedbat/coveragepy |
99 :target: https://github.com/nedbat/coveragepy/actions?query=workflow%3A%22Test+Suite%22 |
101 :alt: Build status |
100 :alt: Build status |
102 .. |win-ci-status| image:: https://ci.appveyor.com/api/projects/status/kmeqpdje7h9r6vsf/branch/master?svg=true |
|
103 :target: https://ci.appveyor.com/project/nedbat/coveragepy |
|
104 :alt: Windows build status |
|
105 .. |docs| image:: https://readthedocs.org/projects/coverage/badge/?version=latest&style=flat |
101 .. |docs| image:: https://readthedocs.org/projects/coverage/badge/?version=latest&style=flat |
106 :target: https://coverage.readthedocs.io/ |
102 :target: https://coverage.readthedocs.io/ |
107 :alt: Documentation |
103 :alt: Documentation |
108 .. |reqs| image:: https://requires.io/github/nedbat/coveragepy/requirements.svg?branch=master |
104 .. |reqs| image:: https://requires.io/github/nedbat/coveragepy/requirements.svg?branch=master |
109 :target: https://requires.io/github/nedbat/coveragepy/requirements/?branch=master |
105 :target: https://requires.io/github/nedbat/coveragepy/requirements/?branch=master |