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.

Raises:

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

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

Return the Frame metadata dictionary 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_metadata_file_path() → str[source]

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

Raises:

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

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.validate() → bool[source]