save_report()

Copy (or move) a finished report into the reports output folder.

Usage

save_report(
    file: str | Path,
    name: str | None = None,
    public: bool = False,
    overwrite: bool = True,
    move: bool = False,
) -> Path

Arguments

Name	Type	Default	Description
file required	str \| Path		The report file.
name	str \| None	None	New file name without extension. Default: keep the name.
public	bool	False	In a sensitive project, save to the public reports folder.
overwrite	bool	True	Replace an existing file.
move	bool	False	Move the file instead of copying it.