format_component_stub#

brainglobe_atlasapi.descriptors.format_component_stub(component_name: str, component_version: str, component_root_dir: str, component_file_name: str) → str[source]#

Format the component stub for a given component name, version, root directory and file name.

Parameters:

  • component_name (str) – The name of the component (e.g., allen-mouse-adult-stpt-template).

  • component_version (str) – The version of the component.

  • component_root_dir (str) – The root directory of the component.

  • component_file_name (str) – The name of the component file.

Returns:

The formatted component stub.

Return type:

str