hermes.commands.curate.base

Classes

HermesCuratePlugin	Base plugin for curate plugins.
CurateSettings	Generic deposition settings.
HermesCurateCommand	Curate the unified metadata before deposition.

Module Contents

class hermes.commands.curate.base.HermesCuratePlugin

Bases: hermes.commands.base.HermesPlugin

Base plugin for curate plugins.

__call__(command: HermesCurateCommand, metadata: hermes.model.SoftwareMetadata) → hermes.model.SoftwareMetadata

Execute the hermes curate plugin self.

Parameters:

• command (HermesCurateCommand) – The command being executed.

• metadata (SoftwareMetadata) – The metadata to be curated.

Returns:

The curated metadata.

Return type:

SoftwareMetadata

class hermes.commands.curate.base.CurateSettings(/, **data: Any)

Bases: pydantic.BaseModel

Generic deposition settings.

plugin

The plugin to be executed.

Type:

str

class hermes.commands.curate.base.HermesCurateCommand(parser: argparse.ArgumentParser)

Bases: hermes.commands.base.HermesCommand

Curate the unified metadata before deposition.

args

The namespace that was returned by the command line parser when reading the arguments.

Type:

Namespace

command_name

(class attribute) The name of the command.

Type:

str

settings_class

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

Type:

type

__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

Raises:

• HermesValidationError – If the results of the process step couldn’t be loaded.

• MisconfigurationError – If the curation plugin wasn’t found.

• HermesPluginRunError – If something went wrong in the plugin run.

load_prov_doc() → hermes.model.provenance.ld_prov.ld_prov_list | None

Loads the provenance document of the process step.

Returns:

The loaded provenance document or None if the load failed.

Return type:

ld_prov_list | None