hermes.commands.deposit.file

Attributes

_log

Classes

`FileDepositSettings`	!!! abstract "Usage Documentation"
`FileDepositPlugin`	Base class that implements the generic deposition workflow.

Module Contents

hermes.commands.deposit.file._log

class hermes.commands.deposit.file.FileDepositSettings(/, **data: Any)

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”: [Models](../concepts/models.md)

A base class for creating Pydantic models.

__class_vars__: The names of the class variables defined on the model.

__private_attributes__: Metadata about the private attributes of the model.

__signature__: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: The core schema of the model.

__pydantic_custom_init__: Whether the model has a custom __init__ function.

__pydantic_decorators__: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__: A dictionary containing metadata about generic Pydantic models. The origin and args items map to the [__origin__][genericalias.__origin__] and [__args__][genericalias.__args__] attributes of [generic aliases][types-genericalias], and the parameter item maps to the __parameter__ attribute of generic classes.

__pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: The name of the post-init method for the model, if defined.

__pydantic_root_model__: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

__pydantic_computed_fields__: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

__pydantic_fields_set__: The names of fields explicitly set during instantiation.

__pydantic_private__: Values of private attributes set on the model instance.

class hermes.commands.deposit.file.FileDepositPlugin

Bases: hermes.commands.deposit.base.HermesDepositPlugin

Base class that implements the generic deposition workflow.

command

The command running this plugin.

Type:: HermesCommand

metadata

The loaded curated metadata.

Type:: SoftwareMetadata

TODO: describe workflow… needs refactoring to be less stateful!

map_metadata() → dict

Map the given metadata to the target schema of the deposition platform and return it.

When mapping metadata, make sure to add traces to the HERMES software, e.g. via DataCite’s relatedIdentifier using the isCompiledBy relation. Ideally, the value of the relation target should be of the respective type for DOIs in your metadata schema, with the value itself being the DOI for the version of the HERMES software you are using.

Returns:: The mapped metadata.
Return type:: dict

update_metadata() → dict

Update the metadata of the newly created version and return it even if it hasn’t changed.

Returns:: The updated metadata.
Return type:: dict

publish() → None

Publish the newly created deposit on the target platform.

Return type:: None