Framework for Python

Notebooks & Scripts

write_framework_template()

Save your version of a template. Returns its path.

Usage

write_framework_template(name: str, contents: str) -> Path

Arguments

Name Type Description
name required str

The template. One of "notebook", "script", or "presentation".

contents required str

The template's text. A trailing newline is added when it has none.

Value

The path the template was written to.

Raises

  • FrameworkError: When name is not a known template.
  • TypeError: When contents is not a string.