brushline.instance_template

The packaged Brushline instance template and its installer.

Install the Brushline instance template overlay on a FEMIC instance.

class brushline.instance_template.InstanceTemplateResult(root: Path, written: tuple[Path, ...], skipped: tuple[Path, ...])[source]

Bases: object

The outcome of installing the Brushline instance template.

Parameters:
  • root (Path) – Instance root.

  • written (tuple of Path) – Files written.

  • skipped (tuple of Path) – Files skipped because they already exist.

brushline.instance_template.install_instance_template(instance_root: Path, *, force: bool = False) → InstanceTemplateResult[source]

Install the Brushline overlay into a FEMIC instance root.

Parameters:
  • instance_root (Path) – FEMIC instance root. It is created when it does not exist.

  • force (bool, optional) – Overwrite existing Brushline template files. Defaults to False.

Returns:

InstanceTemplateResult – The root, written files, and skipped files.

Raises:

FileNotFoundError – When the packaged template is incomplete.