1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
.. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
.. For details: https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt
.. _install:
============
Installation
============
.. :history: 20100725T225600, new for 3.4.
.. :history: 20100820T151500, updated for 3.4b1.
.. :history: 20100906T134800, updated for 3.4b2.
.. :history: 20110604T213400, updated for 3.5b1.
.. :history: 20110629T082400, updated for 3.5.
.. :history: 20110923T081900, updated for 3.5.1.
.. :history: 20120429T162500, updated for 3.5.2b1.
.. :history: 20120503T234000, updated for 3.5.2.
.. :history: 20120929T093600, updated for 3.5.3.
.. :history: 20121117T095000, Now setuptools is a pre-req.
.. :history: 20121128T203000, updated for 3.6b1.
.. :history: 20121223T180800, updated for 3.6b2.
.. :history: 20121229T112400, updated for 3.6b3.
.. :history: 20130105T174400, updated for 3.6.
.. :history: 20131005T210600, updated for 3.7.
.. :history: 20131212T213500, updated for 3.7.1.
.. :history: 20140927T102700, updated for 4.0a1.
.. highlight:: console
.. _coverage_pypi: http://pypi.python.org/pypi/coverage
.. _setuptools: http://pypi.python.org/pypi/setuptools
.. _Distribute: http://packages.python.org/distribute/
Installing coverage.py is done in the usual ways. The simplest way is with
pip::
$ pip install coverage
.. ifconfig:: prerelease
To install a pre-release version, you will need to specify ``--pre``::
$ pip install --pre coverage
The alternate old-school technique is:
#. Install (or already have installed) `setuptools`_ or `Distribute`_.
#. Download the appropriate kit from the
`coverage.py page on the Python Package Index`__.
#. Run ``python setup.py install``.
.. __: coverage_pypi_
Installing dependencies
-----------------------
Coverage.py includes a C extension for speed. It is strongly recommended to use
this extension: it is much faster, and is needed to support a number of
coverage.py features. You may need to install the python-dev and gcc support
files before installing coverage via pip. The exact commands depend on which
package manager you use on your operating system, which Python version you are
using, and on the names of the packages for your distribution. For example::
$ sudo apt-get install python-dev gcc
$ sudo yum install python-devel gcc
$ sudo apt-get install python3-dev gcc
$ sudo yum install python3-devel gcc
Installing on Windows
---------------------
For Windows, kits are provided on the `PyPI page`__ for different versions of
Python and different CPU architectures. These kits require that `setuptools`_
be installed as a pre-requisite, but otherwise are self-contained. They have
the C extension pre-compiled so there's no need to worry about compilers.
.. __: coverage_pypi_
Checking the installation
-------------------------
If all went well, you should be able to open a command prompt, and see
coverage.py installed properly:
.. ifconfig:: not prerelease
.. parsed-literal::
$ coverage --version
Coverage.py, version |release|.
Documentation at https://coverage.readthedocs.org
.. ifconfig:: prerelease
.. parsed-literal::
$ coverage --version
Coverage.py, version |release|.
Documentation at https://coverage.readthedocs.org/en/coverage-|release|
You can also invoke coverage.py as a module:
.. ifconfig:: not prerelease
.. parsed-literal::
$ python -m coverage --version
Coverage.py, version |release|.
Documentation at https://coverage.readthedocs.org
.. ifconfig:: prerelease
.. parsed-literal::
$ python -m coverage --version
Coverage.py, version |release|.
Documentation at https://coverage.readthedocs.org/en/coverage-|release|
|
