frame_cli.metadata module

Module for manipulating FRAME metadata files.

exception frame_cli.metadata.InvalidMetadataFileError[source]

Bases: YAMLError

Invalid metadata file.

exception frame_cli.metadata.MetadataFileAlreadyExistsError[source]

Bases: Exception

FRAME metadata file already exists.

exception frame_cli.metadata.MetadataFileNotFoundError[source]

Bases: Exception

FRAME metadata file not found.

exception frame_cli.metadata.MetadataTemplateFetchError[source]

Bases: Exception

Error fetching the metadata template.

exception frame_cli.metadata.NotInsideGitRepositoryError[source]

Bases: Exception

Not inside a Git repository.

frame_cli.metadata.create_metadata_file() → None[source]

Create a new FRAME metadata file at the root of the current project.

frame_cli.metadata.get_metadata() → dict[source]

Return the FRAME metadata dictionary from the metadata file.

Raises:

YAMLError – If the metadata file is not a valid YAML file.

frame_cli.metadata.get_metadata_file_path(base_dir: str | None = None) → str[source]

Return the path to the FRAME metadata file in the current project.

frame_cli.metadata.get_model_name() → str[source]

Return the model name (unique id) from the metadata file.

Raises:

  • NotInsideGitRepositoryError – If the current directory is not a Git repository.

  • YAMLError – If the metadata file is not a valid YAML file.

frame_cli.metadata.get_model_url() → str | None[source]

Return the model URL from the metadata file.

Raises:

  • NotInsideGitRepositoryError – If the current directory is not a Git repository.

  • YAMLError – If the metadata file is not a valid YAML file.

frame_cli.metadata.metadata_file_exists(base_dir: str | None = None) → bool[source]

Check if the FRAME metadata file exists in the current project.

frame_cli.metadata.show_fair_level(metadata: MetadataFromFile) → None[source]
frame_cli.metadata.validate() → bool[source]