summaryrefslogtreecommitdiff
path: root/doc/api.rst
blob: 17f74b64c665693412b602635267b9b1278516a7 (plain)
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
.. _api:

============
Coverage API
============

:history: 20090524T134300, brand new docs.
:history: 20090613T164000, final touches for 3.0

The API to coverage.py is very simple, contained in a single module called
coverage containing a single class, also called coverage. Methods on the
coverage object correspond to operations available in the command line
interface. For example, a simple use would be::

    import coverage
    
    cov = coverage.coverage()
    cov.start()
    
    # .. run your code ..
    
    cov.stop()
    cov.save()


The coverage module
-------------------

.. module:: coverage

.. autoclass:: coverage
    :members: