whiteprints.cli.init#

Initialize a project.

Exceptions#

CopierCopyError

An error occured while creating the project.

Functions#

init(→ None)

Initialize a python project.

Module Contents#

exception whiteprints.cli.init.CopierCopyError[source]#

Bases: click.ClickException

An error occured while creating the project.

exit_code = 1[source]#

show_color: bool | None[source]#

message[source]#

format_message() → str[source]#

Return type:: str

__str__() → str[source]#

Return str(self).

Return type:: str

show(file: IO[Any] | None = None) → None[source]#

Parameters:: file (Optional[IO[Any]])
Return type:: None

whiteprints.cli.init.init(

project_directory: pathlib.Path,

copier_args: collections.abc.Iterable[str],

**kwargs: Unpack[whiteprints.cli.init_interface.InitKwargs],

) → None[source]#

Initialize a python project.

Parameters:

project_directory (pathlib.Path) – directory the new project will be created.
copier_args (collections.abc.Iterable[str]) – arguments forwarded to copier.
kwargs (Unpack[whiteprints.cli.init_interface.InitKwargs]) – the command line flags.

Raises:

CopierCopyError – An error happened while creating the project.

Return type:

None