hermes.commands.report.base

Classes

`HermesReportSettings`	Configuration of the `report` command.
`HermesReportCommand`	Generate a summarized provenance report for the steps chosen by the user.

class hermes.commands.report.base.HermesReportSettings(/, **data: Any)

Bases: pydantic.BaseModel

Configuration of the report command.

class hermes.commands.report.base.HermesReportCommand(parser: argparse.ArgumentParser)

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

command_name

(class attribute) The name of the command.

settings_class

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

init_command_parser(command_parser: argparse.ArgumentParser) → None

Add arguments for report command.

Parameters:: command_parser (ArgumentParser) – The used argument parser.
Return type:: None

__call__(args: argparse.Namespace) → None

Execute the hermes command self.

Parameters:: args (Namespace) – The namespace that was returned by the command line parser when reading the arguments.
Return type:: None

report_harvest() → None

Print the report for the harvest step.

report_process() → None

Print the report for the process step.

report_curate() → None

Print the report for the curate step.

report_deposit() → None

Print the report for the deposit step.

report_postprocess() → None

Print the report for the harvest step.