.. cuv'ner documentation master file, created by
   sphinx-quickstart on Fri Jan  8 02:37:26 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

cuv'ner
=======

"A commanding view of your test-coverage".

The tool ``cuv`` provides console tools to show coverage data for you
Python project nicely in the console. It uses colour and unicode
characters.

``cuv`` can:

 - graph coverage of all files in your project;
 - colour-ize individual source-code files (via ``less``) by their coverage;
 - colour-ize ``diff`` (or e.g. ``git diff master..HEAD``) by coverage
 - diff ``.coverage`` files themselves


.. toctree::
   :maxdepth: 2

   README.rst

Command Documentation
---------------------

.. click_command:: cuv graph

.. image:: ../screenshots/cuvner-graph-txtorcon.png
    :alt: console graph, showing txtorcon code


.. click_command:: cuv lessopen

.. image:: ../screenshots/cuvner-lessopen-twisted.png
    :alt: pygments + coverage coloring in console


.. click_command:: cuv diff

.. image:: ../screenshots/cuvner-diff-txtorcon.png
    :alt: showing "cuv diff" colouring


.. click_command:: cuv report


.. click_command:: cuv diffcuv


.. click_command:: cuv watch


.. click_command:: cuv next

.. image:: ../screenshots/cuvner-next-txtorcon.png
    :alt: showing "cuv next" for above 'graph' screenshot


.. click_command:: cuv spark

.. image:: ../screenshots/cuvner-spark-txtorcon.png
    :alt: spark-line coverage of txtorcon


.. click_command:: cuv readme