Framework for Python

Notebooks & Scripts

stubs_publish()

Copy Framework's stubs into the project's stubs/ folder to customize them.

Usage

stubs_publish(
    type: str | list[str] = 'all',
    *,
    overwrite: bool = False,
    stubs: list[str] | None = None,
) -> list[Path]

Arguments

Name Type Default Description
type str | list[str] 'all'

"all", "notebooks", or "scripts", or a list of them.

overwrite bool False

Replace stubs already in stubs/.

stubs list[str] | None None

Only these stub names, such as ["default"].

Value

The files copied.