|
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 =========== |
|
5 Coverage.py |
|
6 =========== |
|
7 |
|
8 Code coverage testing for Python. |
|
9 |
|
10 | |license| |versions| |status| |docs| |
|
11 | |ci-status| |win-ci-status| |codecov| |
|
12 | |kit| |format| |repos| |
|
13 | |tidelift| |saythanks| |
|
14 |
|
15 .. downloads badge seems to be broken... |downloads| |
|
16 |
|
17 Coverage.py measures code coverage, typically during test execution. It uses |
|
18 the code analysis tools and tracing hooks provided in the Python standard |
|
19 library to determine which lines are executable, and which have been executed. |
|
20 |
|
21 .. |tideliftlogo| image:: doc/media/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White_small.png |
|
22 :width: 75 |
|
23 :alt: Tidelift |
|
24 |
|
25 .. list-table:: |
|
26 :widths: 10 100 |
|
27 |
|
28 * - |tideliftlogo| |
|
29 - Professional support for coverage.py is available as part of the `Tidelift |
|
30 Subscription`_. Tidelift gives software development teams a single source for |
|
31 purchasing and maintaining their software, with professional grade assurances |
|
32 from the experts who know it best, while seamlessly integrating with existing |
|
33 tools. |
|
34 |
|
35 .. _Tidelift Subscription: https://tidelift.com/subscription/pkg/pypi-coverage?utm_source=pypi-coverage&utm_medium=referral&utm_campaign=readme |
|
36 |
|
37 Coverage.py runs on many versions of Python: |
|
38 |
|
39 * CPython 2.6, 2.7 and 3.3 through pre-alpha 3.8. |
|
40 * PyPy2 5.10 and PyPy3 5.10. |
|
41 * Jython 2.7.1, though not for reporting. |
|
42 * IronPython 2.7.7, though not for reporting. |
|
43 |
|
44 Documentation is on `Read the Docs`_. Code repository and issue tracker are on |
|
45 `Bitbucket`_, with a mirrored repository on `GitHub`_. |
|
46 |
|
47 .. _Read the Docs: https://coverage.readthedocs.io/ |
|
48 .. _Bitbucket: https://bitbucket.org/ned/coveragepy |
|
49 .. _GitHub: https://github.com/nedbat/coveragepy |
|
50 |
|
51 |
|
52 **New in 4.5:** Configurator plug-ins. |
|
53 |
|
54 New in 4.4: Suppressable warnings, continuous coverage measurement. |
|
55 |
|
56 New in 4.3: HTML ``--skip-covered``, sys.excepthook support, tox.ini |
|
57 support. |
|
58 |
|
59 New in 4.2: better support for multiprocessing and combining data. |
|
60 |
|
61 New in 4.1: much-improved branch coverage. |
|
62 |
|
63 New in 4.0: ``--concurrency``, plugins for non-Python files, setup.cfg |
|
64 support, --skip-covered, HTML filtering, and more than 50 issues closed. |
|
65 |
|
66 |
|
67 Getting Started |
|
68 --------------- |
|
69 |
|
70 See the `Quick Start section`_ of the docs. |
|
71 |
|
72 .. _Quick Start section: https://coverage.readthedocs.io/#quick-start |
|
73 |
|
74 |
|
75 Contributing |
|
76 ------------ |
|
77 |
|
78 See the `Contributing section`_ of the docs. |
|
79 |
|
80 .. _Contributing section: https://coverage.readthedocs.io/en/latest/contributing.html |
|
81 |
|
82 |
|
83 License |
|
84 ------- |
|
85 |
|
86 Licensed under the `Apache 2.0 License`_. For details, see `NOTICE.txt`_. |
|
87 |
|
88 .. _Apache 2.0 License: http://www.apache.org/licenses/LICENSE-2.0 |
|
89 .. _NOTICE.txt: https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt |
|
90 |
|
91 |
|
92 .. |ci-status| image:: https://travis-ci.org/nedbat/coveragepy.svg?branch=master |
|
93 :target: https://travis-ci.org/nedbat/coveragepy |
|
94 :alt: Build status |
|
95 .. |win-ci-status| image:: https://ci.appveyor.com/api/projects/status/kmeqpdje7h9r6vsf/branch/master?svg=true |
|
96 :target: https://ci.appveyor.com/project/nedbat/coveragepy |
|
97 :alt: Windows build status |
|
98 .. |docs| image:: https://readthedocs.org/projects/coverage/badge/?version=latest&style=flat |
|
99 :target: https://coverage.readthedocs.io/ |
|
100 :alt: Documentation |
|
101 .. |reqs| image:: https://requires.io/github/nedbat/coveragepy/requirements.svg?branch=master |
|
102 :target: https://requires.io/github/nedbat/coveragepy/requirements/?branch=master |
|
103 :alt: Requirements status |
|
104 .. |kit| image:: https://badge.fury.io/py/coverage.svg |
|
105 :target: https://pypi.python.org/pypi/coverage |
|
106 :alt: PyPI status |
|
107 .. |format| image:: https://img.shields.io/pypi/format/coverage.svg |
|
108 :target: https://pypi.python.org/pypi/coverage |
|
109 :alt: Kit format |
|
110 .. |downloads| image:: https://img.shields.io/pypi/dw/coverage.svg |
|
111 :target: https://pypi.python.org/pypi/coverage |
|
112 :alt: Weekly PyPI downloads |
|
113 .. |versions| image:: https://img.shields.io/pypi/pyversions/coverage.svg |
|
114 :target: https://pypi.python.org/pypi/coverage |
|
115 :alt: Python versions supported |
|
116 .. |status| image:: https://img.shields.io/pypi/status/coverage.svg |
|
117 :target: https://pypi.python.org/pypi/coverage |
|
118 :alt: Package stability |
|
119 .. |license| image:: https://img.shields.io/pypi/l/coverage.svg |
|
120 :target: https://pypi.python.org/pypi/coverage |
|
121 :alt: License |
|
122 .. |codecov| image:: http://codecov.io/github/nedbat/coveragepy/coverage.svg?branch=master&precision=2 |
|
123 :target: http://codecov.io/github/nedbat/coveragepy?branch=master |
|
124 :alt: Coverage! |
|
125 .. |repos| image:: https://repology.org/badge/tiny-repos/python:coverage.svg |
|
126 :target: https://repology.org/metapackage/python:coverage/versions |
|
127 :alt: Packaging status |
|
128 .. |saythanks| image:: https://img.shields.io/badge/saythanks.io-%E2%98%BC-1EAEDB.svg |
|
129 :target: https://saythanks.io/to/nedbat |
|
130 :alt: Say thanks :) |
|
131 .. |tidelift| image:: https://tidelift.com/badges/github/nedbat/coveragepy |
|
132 :target: https://tidelift.com/subscription/pkg/pypi-coverage?utm_source=pypi-coverage&utm_medium=referral&utm_campaign=readme |
|
133 :alt: Tidelift |