find_config

find_config(start_path: Path | str | None = None, config_file_name: str = 'pyproject.toml') → Path[source]

Find config file based on its name and start path, by traversing parent paths.

Parameters:

  • start_path (Optional[Union[Path,str]]) – Path to start looking for the config file. Defaults to None which means the current dir will be used

  • config_file_name (str) – Name of the config file. Defaults to “pyproject.toml”

Returns:

Path of the found config file

Return type:

Path

Raises:

ConfigNotFoundError – If no config file could be found.