.. _doot.reporters:
  
==============
doot.reporters
==============
  


.. py:module:: doot.reporters

.. autoapi-nested-parse::

   Reporter: A Module for structured user-directed messaging.

   A Reporter has various ReporterGroup's as attributes,
   which enable certain formatted output.

   eg:
   - TreeGroup for printing a tree of data
   - WorkflowGroup for outputing the progress of a workflow as it happens
   - SummaryGroup for outputing a summary *after* a workflow completes

   Formatting is handled by ReportFormatter's

 


Submodules
----------

.. toctree::
   :maxdepth: 1

   /_docs/_autoapi/doot/reporters/_interface/index
   /_docs/_autoapi/doot/reporters/basic/index
   /_docs/_autoapi/doot/reporters/formatter/index