hermes.commands.report.base
===========================

.. py:module:: hermes.commands.report.base


Classes
-------

.. autoapisummary::

   hermes.commands.report.base.HermesReportSettings
   hermes.commands.report.base.HermesReportCommand


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

.. py:class:: HermesReportSettings(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   Configuration of the ``report`` command.


.. py:class:: HermesReportCommand(parser: argparse.ArgumentParser)

   Bases: :py:obj:`hermes.commands.base.HermesCommand`


   Generate a summarized provenance report for the steps chosen by the user.

   .. attribute:: command_name

      (class attribute) The name of the command.

      :type: str

   .. attribute:: settings_class

      (class attribute) The settings class for general report settings.

      :type: type


   .. py:method:: init_command_parser(command_parser: argparse.ArgumentParser) -> None

      Add arguments for report command.

      :param command_parser: The used argument parser.
      :type command_parser: ArgumentParser

      :rtype: None



   .. py:method:: __call__(args: argparse.Namespace) -> None

      Execute the hermes command `self`.

      :param args: The namespace that was returned by the command line parser when reading the arguments.
      :type args: Namespace

      :rtype: None



   .. py:method:: report_harvest() -> None

      Print the report for the harvest step.

      :rtype: None



   .. py:method:: report_process() -> None

      Print the report for the process step.

      :rtype: None



   .. py:method:: report_curate() -> None

      Print the report for the curate step.

      :rtype: None



   .. py:method:: report_deposit() -> None

      Print the report for the deposit step.

      :rtype: None



   .. py:method:: report_postprocess() -> None

      Print the report for the harvest step.

      :rtype: None