Project Utilities#

find_project_root() Path[source]#

Find the project root directory containing .briskconfig.

Searches current directory and parent directories for .briskconfig file. Result is cached to avoid repeated filesystem operations.

Returns:
pathlib.Path

Path to project root directory

Raises:
FileNotFoundError

If .briskconfig cannot be found in any parent directory

Examples

>>> root = find_project_root()
>>> datasets_dir = root / 'datasets'
>>> config_file = root / '.briskconfig'