Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

HTML coverage report generator for trace.py

Project description

trace2html
==========

:author: Olivier Grisel

`trace2html` is a utility to convert execution coverage data obtained
with the `trace` module of the standard python library into a set of human
readable HTML documents showing sortable summary and annotated source files.

Installation
------------

As usual, you can either use `sudo easy_install -U trace2html` or extract the
archive and run::

$ sudo python setup.py install

Sample usage
------------

Use trace2html to directly compute the coverage of a test suite by
specifying the module you are interested in::

$ trace2html.py -w my_module --run-command ./my_testrunner.py
$ firefox coverage_dir/index.html

Or you can collect coverage data generated with trace.py::

$ /usr/lib/python2.4/trace.py -mc -C coverage_dir -f counts my_testrunner.py

Write a report in directory 'other_dir' from data collected in 'counts'::

$ trace2html.py -f counts -o other_dir
$ firefox other_dir/index.html

Use the `--help` option for more details.

Licensing
---------

`trace2html` is released under the GNU/GPL v2 license (see COPYING.txt for more
details) and uses the

I would not mind relicensing `trace2html` under a more liberal license such as
the Python or ZPL licenses but that would only be useful if someone find or
write a replacement for the WebFX Sortable Table JS file under a similar
license. SortableTable.js is currently under GPLv2.

Bug reports and patches
-----------------------

You can directly send bug reports and patches to my personnal email address::

olivier.grisel@ensta.org

Or you can use `bzr`__ to branch my repository::

$ bzr branch lp:trace2html


then publish your branch on some site and send me a merge request. Please
follow the `5-minute tutorial`__ if you are new to bzr.

Credits
-------

`trace2html` is inspired by the `cobertura project`__ for java programs. It
includes Javascript code from WebFX Sortable Table and Cobertura.

.. References
__`bzr`:: http://bazaar-vcs.org/
__`5-minute tutorial`:: http://bazaar-vcs.org/QuickHackingWithBzr
__`cobertura project`:: http://cobertura.sourceforge.net

Changelog
=========

0.2.1
-----

- packaging bugfixes (added missing files in the source distribution)
(thanks to Grig Gheorghiu for the bug reports)

0.2.0
-----

- trace2html.py can now be directly used to collect coverage data
- new whitelist system to explicitely restrict the traced modules

0.1.1
-----

- minor bugfix in options help message

0.1.0
-----

- initial revision

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for trace2html, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size trace2html-0.2.1-py2.4.egg (15.1 kB) File type Egg Python version 2.4 Upload date Hashes View hashes
Filename, size trace2html-0.2.1.tar.gz (25.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page