bootstrap()

Prepare a cloned project so it is ready to work in.

Usage

bootstrap(
    path: str | Path = '.',
    *,
    interactive: bool = False,
    packages: bool = True,
) -> BootstrapResult

Name	Type	Default	Description
path	str \| Path	'.'	The project folder.
interactive	bool	False	Ask for the values of empty `.env` variables. Without it, bootstrap never prompts and lists them as to-dos instead.
packages	bool	True	Install the packages with uv.

A BootstrapResult with the steps taken and the to-dos left.

FrameworkError: The project cannot be prepared: there is no settings file, the project is not a Python project, its spec is invalid, or the packages could not be installed.