|
1 .. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 |
|
2 .. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt |
|
3 |
|
4 =========== |
|
5 Coverage.py |
|
6 =========== |
|
7 |
|
8 Code coverage testing for Python. |
|
9 |
|
10 | |license| |versions| |status| |
|
11 | |ci-status| |docs| |codecov| |
|
12 | |kit| |format| |repos| |downloads| |
|
13 | |stars| |forks| |contributors| |
|
14 | |tidelift| |twitter-coveragepy| |twitter-nedbat| |
|
15 |
|
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 |
|
18 library to determine which lines are executable, and which have been executed. |
|
19 |
|
20 Coverage.py runs on many versions of Python: |
|
21 |
|
22 * CPython 2.7. |
|
23 * CPython 3.5 through 3.10 alpha. |
|
24 * PyPy2 7.3.1 and PyPy3 7.3.1. |
|
25 |
|
26 Documentation is on `Read the Docs`_. Code repository and issue tracker are on |
|
27 `GitHub`_. |
|
28 |
|
29 .. _Read the Docs: https://coverage.readthedocs.io/ |
|
30 .. _GitHub: https://github.com/nedbat/coveragepy |
|
31 |
|
32 |
|
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. |
|
35 |
|
36 |
|
37 For Enterprise |
|
38 -------------- |
|
39 |
|
40 .. |tideliftlogo| image:: https://nedbatchelder.com/pix/Tidelift_Logo_small.png |
|
41 :alt: Tidelift |
|
42 :target: https://tidelift.com/subscription/pkg/pypi-coverage?utm_source=pypi-coverage&utm_medium=referral&utm_campaign=readme |
|
43 |
|
44 .. list-table:: |
|
45 :widths: 10 100 |
|
46 |
|
47 * - |tideliftlogo| |
|
48 - `Available as part of the Tidelift Subscription. <https://tidelift.com/subscription/pkg/pypi-coverage?utm_source=pypi-coverage&utm_medium=referral&utm_campaign=readme>`_ |
|
49 Coverage and thousands of other packages are working with |
|
50 Tidelift to deliver one enterprise subscription that covers all of the open |
|
51 source you use. If you want the flexibility of open source and the confidence |
|
52 of commercial-grade software, this is for you. |
|
53 `Learn more. <https://tidelift.com/subscription/pkg/pypi-coverage?utm_source=pypi-coverage&utm_medium=referral&utm_campaign=readme>`_ |
|
54 |
|
55 |
|
56 Getting Started |
|
57 --------------- |
|
58 |
|
59 See the `Quick Start section`_ of the docs. |
|
60 |
|
61 .. _Quick Start section: https://coverage.readthedocs.io/#quick-start |
|
62 |
|
63 |
|
64 Change history |
|
65 -------------- |
|
66 |
|
67 The complete history of changes is on the `change history page`_. |
|
68 |
|
69 .. _change history page: https://coverage.readthedocs.io/en/latest/changes.html |
|
70 |
|
71 |
|
72 Contributing |
|
73 ------------ |
|
74 |
|
75 See the `Contributing section`_ of the docs. |
|
76 |
|
77 .. _Contributing section: https://coverage.readthedocs.io/en/latest/contributing.html |
|
78 |
|
79 |
|
80 Security |
|
81 -------- |
|
82 |
|
83 To report a security vulnerability, please use the `Tidelift security |
|
84 contact`_. Tidelift will coordinate the fix and disclosure. |
|
85 |
|
86 .. _Tidelift security contact: https://tidelift.com/security |
|
87 |
|
88 |
|
89 License |
|
90 ------- |
|
91 |
|
92 Licensed under the `Apache 2.0 License`_. For details, see `NOTICE.txt`_. |
|
93 |
|
94 .. _Apache 2.0 License: http://www.apache.org/licenses/LICENSE-2.0 |
|
95 .. _NOTICE.txt: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt |
|
96 |
|
97 |
|
98 .. |ci-status| image:: https://github.com/nedbat/coveragepy/workflows/Test%20Suite/badge.svg |
|
99 :target: https://github.com/nedbat/coveragepy/actions?query=workflow%3A%22Test+Suite%22 |
|
100 :alt: Build status |
|
101 .. |docs| image:: https://readthedocs.org/projects/coverage/badge/?version=latest&style=flat |
|
102 :target: https://coverage.readthedocs.io/ |
|
103 :alt: Documentation |
|
104 .. |reqs| image:: https://requires.io/github/nedbat/coveragepy/requirements.svg?branch=master |
|
105 :target: https://requires.io/github/nedbat/coveragepy/requirements/?branch=master |
|
106 :alt: Requirements status |
|
107 .. |kit| image:: https://badge.fury.io/py/coverage.svg |
|
108 :target: https://pypi.org/project/coverage/ |
|
109 :alt: PyPI status |
|
110 .. |format| image:: https://img.shields.io/pypi/format/coverage.svg |
|
111 :target: https://pypi.org/project/coverage/ |
|
112 :alt: Kit format |
|
113 .. |downloads| image:: https://img.shields.io/pypi/dw/coverage.svg |
|
114 :target: https://pypi.org/project/coverage/ |
|
115 :alt: Weekly PyPI downloads |
|
116 .. |versions| image:: https://img.shields.io/pypi/pyversions/coverage.svg?logo=python&logoColor=FBE072 |
|
117 :target: https://pypi.org/project/coverage/ |
|
118 :alt: Python versions supported |
|
119 .. |status| image:: https://img.shields.io/pypi/status/coverage.svg |
|
120 :target: https://pypi.org/project/coverage/ |
|
121 :alt: Package stability |
|
122 .. |license| image:: https://img.shields.io/pypi/l/coverage.svg |
|
123 :target: https://pypi.org/project/coverage/ |
|
124 :alt: License |
|
125 .. |codecov| image:: https://codecov.io/github/nedbat/coveragepy/coverage.svg?branch=master&precision=2 |
|
126 :target: https://codecov.io/github/nedbat/coveragepy?branch=master |
|
127 :alt: Coverage! |
|
128 .. |repos| image:: https://repology.org/badge/tiny-repos/python:coverage.svg |
|
129 :target: https://repology.org/metapackage/python:coverage/versions |
|
130 :alt: Packaging status |
|
131 .. |tidelift| image:: https://tidelift.com/badges/package/pypi/coverage |
|
132 :target: https://tidelift.com/subscription/pkg/pypi-coverage?utm_source=pypi-coverage&utm_medium=referral&utm_campaign=readme |
|
133 :alt: Tidelift |
|
134 .. |stars| image:: https://img.shields.io/github/stars/nedbat/coveragepy.svg?logo=github |
|
135 :target: https://github.com/nedbat/coveragepy/stargazers |
|
136 :alt: Github stars |
|
137 .. |forks| image:: https://img.shields.io/github/forks/nedbat/coveragepy.svg?logo=github |
|
138 :target: https://github.com/nedbat/coveragepy/network/members |
|
139 :alt: Github forks |
|
140 .. |contributors| image:: https://img.shields.io/github/contributors/nedbat/coveragepy.svg?logo=github |
|
141 :target: https://github.com/nedbat/coveragepy/graphs/contributors |
|
142 :alt: Contributors |
|
143 .. |twitter-coveragepy| image:: https://img.shields.io/twitter/follow/coveragepy.svg?label=coveragepy&style=flat&logo=twitter&logoColor=4FADFF |
|
144 :target: https://twitter.com/coveragepy |
|
145 :alt: coverage.py on Twitter |
|
146 .. |twitter-nedbat| image:: https://img.shields.io/twitter/follow/nedbat.svg?label=nedbat&style=flat&logo=twitter&logoColor=4FADFF |
|
147 :target: https://twitter.com/nedbat |
|
148 :alt: nedbat on Twitter |