open

classmethod Project.open(project_folder_or_file: str | Path, create_if_not_exist: bool = True) → Project[source]

Open a new project.

Parameters:

  • project_folder_or_file (str | Path) – The path to a project folder or file.

  • create_if_not_exist (bool) – Create the project if not existent.

Returns:

The project instance.

Return type:

Project

Raises:

FileNotFoundError – Raised when the project file does not not exist and create_if_not_exist is False.