Installation

You can install coverage.py in the usual ways. The simplest way is with pip:

$ pip install coverage

C Extension

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. Most of the time, the C extension will be installed without any special action on your part.

You can determine if you are using the extension by looking at the output of coverage --version:

$ coverage --version
Coverage.py, version 5.3 with C extension
Documentation at https://coverage.readthedocs.io/en/coverage-5.3

The first line will either say “with C extension,” or “without C extension.”

If you are missing the extension, first make sure you have the latest version of pip in use when installing coverage.

If you are installing on Linux, 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, which Python version you are using, and 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

A few features of coverage.py aren’t supported without the C extension, such as concurrency and plugins.

Checking the installation

If all went well, you should be able to open a command prompt, and see coverage.py installed properly:

$ coverage --version
Coverage.py, version 5.3 with C extension
Documentation at https://coverage.readthedocs.io/en/coverage-5.3

You can also invoke coverage.py as a module:

$ python -m coverage --version
Coverage.py, version 5.3 with C extension
Documentation at https://coverage.readthedocs.io/en/coverage-5.3