Metadata-Version: 1.0
Name: tha.coverage
Version: 1.0
Summary: Provides single script to create coverage reports
Home-page: http://www.thehealthagency.com
Author: The Health Agency
Author-email: techniek@thehealthagency.com
License: BSD
Description: tha.coverage
        ============
        
        tha.coverage provides a ``bin/createcoverage`` script that servers as a
        one-line coverage report generator.  It is essentially a wrapper around
        `z3c.coverage <http://pypi.python.org/pypi/z3c.coverage>`_.  It is intended
        for use inside buildouts, so there are two assumptions:
        
        - The directory you run this script from is the root of the buildout.
        
        - There is a ``bin/test``.
        
        
        Installation and use
        --------------------
        
        To install, add ``tha.coverage`` to a zc.recipe.egg section.  You often
        already have one for common scripts.  So something like this::
        
        [buildout]
        ...
        parts =
        ...
        console_scripts
        
        [console_scripts]
        recipe = zc.recipe.egg
        eggs =
        ...
        tha.coverage
        
        This gives you a ``bin/createcoverage`` script that does the following:
        
        - Check whether bin/test exists.  Safety feature.
        
        - Remove old coverage dir if it exists.  This way you always have clean
        results.
        
        - Run bin/test with the ``--coverage=...`` option.
        
        - Use z3c.coverage to create the actual reports.  By default into
        ``./coverage/reports``.  If you start createcoverage with a command line
        argument (``bin/createcoverage /tmp/output``) it will put the reports into
        that directory.
        
        - Open the reports in your webbrowser *if you did not specify an output
        directory*.  The assumption here is that if you run the script as-is, you
        just want to see the coverage reports.  If you *do* specify an output
        directory, you're probably running it from within buildbot or so on the
        server and you want the output in some webserver-served directory.  No use
        to open a browser on the server.
        
        
        OSX comment
        -----------
        
        z3c.coverage uses the "enscript" command for python code highlighting.  The
        version provided by OSX before 10.5.7 complains about an unkown ``--footer``
        argument passed by z3c.coverage.  There are two possible solutions:
        
        - Update to 10.5.7.  That update came out a few minutes after I wrote this
        original comment :-)
        
        - Install enscript from macports.
        
        - Add a script called "enscript" on your path that calls the original enscript
        minus the offending argument::
        
        #!/bin/sh
        shift
        /usr/bin/enscript -q --header -h --language=html --color -o - $9
        
        
        More info
        ---------
        
        Technical details and a full doctest are in src/tha/coverage/USAGE.txt .
        
        Made by `Reinout van Rees <http://reinout.vanrees.org>`_ at `The Health Agency
        <http://www.thehealthagency.com>`_.
        
        
        TODO
        ====
        
        - Await first bug reports :-)
        
        
        Changelog of tha.coverage
        =========================
        
        
        1.0 (2009-12-18)
        ----------------
        
        - Added license, doc update.  [reinout]
        
        
        0.1.1 (2009-05-13)
        ------------------
        
        - Doc update: osx 10.5.7 fixes the enscript problem.  [reinout]
        
        - Cleaned up some thaskel-added stuff that's not needed for a generic
        library.  [reinout]
        
        
        0.1 (2009-05-13)
        ----------------
        
        - Implemented first working version.  [reinout]
        
        - Initial library skeleton created by thaskel.  [reinout]
        
        
        
Platform: UNKNOWN
