create

static Project.create(folder: str | Path, allow_overwrite: bool = False) → Project[source]

Create a new project folder and file.

Parameters:

  • folder (str | Path | None) – The folder where the project will be created. If None, the current work directory will be used.

  • allow_overwrite (bool) – Whether to overwrite an existing project file.

Returns:

The created project.

Return type:

Project

Raises:

FileExistsError – Raised if the project file already exists and allow_overwrite=False.