roller.reporter
===============

.. py:module:: roller.reporter

.. autoapi-nested-parse::

   Output formatting and reporting for changes-roller.



Classes
-------

.. autoapisummary::

   roller.reporter.Status
   roller.reporter.Reporter


Module Contents
---------------

.. py:class:: Status(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Status indicators for operations.


   .. py:attribute:: SUCCESS
      :value: '✓'



   .. py:attribute:: FAILED
      :value: '✗'



   .. py:attribute:: INFO
      :value: 'ℹ'



   .. py:attribute:: RUNNING
      :value: '→'



.. py:class:: Reporter(verbose = False)

   Handles formatted output for the CLI.


   .. py:attribute:: verbose
      :value: False



   .. py:attribute:: results
      :type:  list[dict[str, Any]]
      :value: []



   .. py:method:: print_header(topic, workspace)

      Print the series header.



   .. py:method:: print_repo_start(index, total, repo_name)

      Print the start of repository processing.



   .. py:method:: print_step(status, message, indent = 2)

      Print a step with status indicator.



   .. py:method:: add_result(repo_name, status, details = '')

      Record a result for summary.



   .. py:method:: print_summary()

      Print the final summary.