DebugClients/Python/coverage/doc/README.rst

changeset 6219
d6c795b5ce33
parent 5178
878ce843ca9f
child 6649
f1b3a73831c9
equal deleted inserted replaced
6218:bedab77d0fa3 6219:d6c795b5ce33
7 7
8 Code coverage testing for Python. 8 Code coverage testing for Python.
9 9
10 | |license| |versions| |status| |docs| 10 | |license| |versions| |status| |docs|
11 | |ci-status| |win-ci-status| |codecov| 11 | |ci-status| |win-ci-status| |codecov|
12 | |kit| |format| |downloads| 12 | |kit| |format| |saythanks|
13
14 .. downloads badge seems to be broken... |downloads|
13 15
14 Coverage.py measures code coverage, typically during test execution. It uses 16 Coverage.py measures code coverage, typically during test execution. It uses
15 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
16 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.
17 19
18 Coverage.py runs on CPython 2.6, 2.7, and 3.3 through 3.6; PyPy 4.0 and 5.1; 20 Coverage.py runs on many versions of Python:
19 and PyPy3 2.4.
20 21
21 Documentation is on `Read the Docs <http://coverage.readthedocs.io>`_. 22 * CPython 2.6, 2.7 and 3.3 through 3.7.
22 Code repository and issue tracker are on `Bitbucket <http://bitbucket.org/ned/coveragepy>`_, 23 * PyPy2 5.10 and PyPy3 5.10.
23 with a mirrored repository on `GitHub <https://github.com/nedbat/coveragepy>`_. 24 * Jython 2.7.1, though not for reporting.
25 * IronPython 2.7.7, though not for reporting.
24 26
25 **New in 4.1:** much-improved branch coverage. 27 Documentation is on `Read the Docs`_. Code repository and issue tracker are on
28 `Bitbucket`_, with a mirrored repository on `GitHub`_.
29
30 .. _Read the Docs: https://coverage.readthedocs.io/
31 .. _Bitbucket: https://bitbucket.org/ned/coveragepy
32 .. _GitHub: https://github.com/nedbat/coveragepy
33
34
35 **New in 4.5:** Configurator plug-ins.
36
37 New in 4.4: Suppressable warnings, continuous coverage measurement.
38
39 New in 4.3: HTML ``--skip-covered``, sys.excepthook support, tox.ini
40 support.
41
42 New in 4.2: better support for multiprocessing and combining data.
43
44 New in 4.1: much-improved branch coverage.
26 45
27 New in 4.0: ``--concurrency``, plugins for non-Python files, setup.cfg 46 New in 4.0: ``--concurrency``, plugins for non-Python files, setup.cfg
28 support, --skip-covered, HTML filtering, and more than 50 issues closed. 47 support, --skip-covered, HTML filtering, and more than 50 issues closed.
29 48
30 49
31 Getting Started 50 Getting Started
32 --------------- 51 ---------------
33 52
34 See the `quick start <http://coverage.readthedocs.io/#quick-start>`_ 53 See the `Quick Start section`_ of the docs.
35 section of the docs. 54
55 .. _Quick Start section: https://coverage.readthedocs.io/#quick-start
56
57
58 Contributing
59 ------------
60
61 See the `Contributing section`_ of the docs.
62
63 .. _Contributing section: https://coverage.readthedocs.io/en/latest/contributing.html
36 64
37 65
38 License 66 License
39 ------- 67 -------
40 68
41 Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0. 69 Licensed under the `Apache 2.0 License`_. For details, see `NOTICE.txt`_.
42 For details, see https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt. 70
71 .. _Apache 2.0 License: http://www.apache.org/licenses/LICENSE-2.0
72 .. _NOTICE.txt: https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt
43 73
44 74
45 .. |ci-status| image:: https://travis-ci.org/nedbat/coveragepy.svg?branch=master 75 .. |ci-status| image:: https://travis-ci.org/nedbat/coveragepy.svg?branch=master
46 :target: https://travis-ci.org/nedbat/coveragepy 76 :target: https://travis-ci.org/nedbat/coveragepy
47 :alt: Build status 77 :alt: Build status
48 .. |win-ci-status| image:: https://ci.appveyor.com/api/projects/status/bitbucket/ned/coveragepy?svg=true 78 .. |win-ci-status| image:: https://ci.appveyor.com/api/projects/status/kmeqpdje7h9r6vsf/branch/master?svg=true
49 :target: https://ci.appveyor.com/project/nedbat/coveragepy 79 :target: https://ci.appveyor.com/project/nedbat/coveragepy
50 :alt: Windows build status 80 :alt: Windows build status
51 .. |docs| image:: https://readthedocs.org/projects/coverage/badge/?version=latest&style=flat 81 .. |docs| image:: https://readthedocs.org/projects/coverage/badge/?version=latest&style=flat
52 :target: http://coverage.readthedocs.io 82 :target: https://coverage.readthedocs.io/
53 :alt: Documentation 83 :alt: Documentation
54 .. |reqs| image:: https://requires.io/github/nedbat/coveragepy/requirements.svg?branch=master 84 .. |reqs| image:: https://requires.io/github/nedbat/coveragepy/requirements.svg?branch=master
55 :target: https://requires.io/github/nedbat/coveragepy/requirements/?branch=master 85 :target: https://requires.io/github/nedbat/coveragepy/requirements/?branch=master
56 :alt: Requirements status 86 :alt: Requirements status
57 .. |kit| image:: https://badge.fury.io/py/coverage.svg 87 .. |kit| image:: https://badge.fury.io/py/coverage.svg
70 :target: https://pypi.python.org/pypi/coverage 100 :target: https://pypi.python.org/pypi/coverage
71 :alt: Package stability 101 :alt: Package stability
72 .. |license| image:: https://img.shields.io/pypi/l/coverage.svg 102 .. |license| image:: https://img.shields.io/pypi/l/coverage.svg
73 :target: https://pypi.python.org/pypi/coverage 103 :target: https://pypi.python.org/pypi/coverage
74 :alt: License 104 :alt: License
75 .. |codecov| image:: http://codecov.io/github/nedbat/coveragepy/coverage.svg?branch=master 105 .. |codecov| image:: http://codecov.io/github/nedbat/coveragepy/coverage.svg?branch=master&precision=2
76 :target: http://codecov.io/github/nedbat/coveragepy?branch=master 106 :target: http://codecov.io/github/nedbat/coveragepy?branch=master
77 :alt: Coverage! 107 :alt: Coverage!
108 .. |saythanks| image:: https://img.shields.io/badge/saythanks.io-%E2%98%BC-1EAEDB.svg
109 :target: https://saythanks.io/to/nedbat
110 :alt: Say thanks :)

eric ide

mercurial