Framework for Python
R Python CLI

Project Management

project_root()

The root folder of the Framework project containing start (default: the current folder).

Usage

project_root(start: str | Path | None = None) -> Path

Arguments

Name Type Default Description
start str | Path | None None

The folder to search from. The search moves up through its parents. Default: the current directory.

Value

The folder that holds the project's settings.yml or config.yml.

Raises

  • ProjectNotFoundError: No settings.yml or config.yml was found.