summaryrefslogtreecommitdiff
path: root/doc/en/test/plugin/figleaf.rst
blob: 0c1603ade9fc3df17b822182d8f3579b2b6c8787 (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
33
34
35
36
37
38
39
40
41
42
43
44

report test coverage using the 'figleaf' package.
=================================================


.. contents::
  :local:

Install
---------------

To install the plugin issue::

    easy_install pytest-figleaf  # or
    pip install pytest-figleaf   

and if you are using pip you can also uninstall::

    pip uninstall pytest-figleaf


Usage
---------------

After installation you can simply type::

    pytest --figleaf [...]

to enable figleaf coverage in your test run.  A default ".figleaf" data file
and "html" directory will be created.  You can use command line options
to control where data and html files are created.

command line options
--------------------


``--figleaf``
    trace python coverage with figleaf and write HTML for files below the current working dir
``--fig-data=dir``
    set tracing file, default: ".figleaf".
``--fig-html=dir``
    set html reporting dir, default "html".

.. include:: links.txt