DebugClients/Python/coverage/doc/README.rst

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

eric ide

mercurial