Utilities

find_project_brand_yml

find_project_brand_yml(path)

Find a project’s _brand.yml file

Finds the first _brand.yml file in or adjacent to path and its parents. If path is a file, find_project_brand_yml() starts looking in the path’s parent directory. In each directory, find_project_brand_yml() looks for any of the following files in the given order:

• _brand.yml
• _brand.yaml
• brand/_brand.yml
• brand/_brand.yaml
• _brand/_brand.yml
• _brand/_brand.yaml

Parameters

path: Path | str

A path to a file or directory where the search for the project’s _brand.yml file should be located.

Returns

Name	Type	Description
	Path	The path of the found _brand.yml.

Raises

Name	Type	Description
	FileNotFoundError	If no _brand.yml is found in any of the directories above path.