Framework for Python

Workflow

project_info()

The project's configured folders and whether each exists yet.

Folders that do not exist are created the first time something is saved there. With verbose, the project name and type are printed too.

Usage

project_info(verbose: bool = False) -> pd.DataFrame

Arguments

Name Type Default Description
verbose bool False

Print the project name and type.

Value

A DataFrame with columns key, path, and exists. Its attrs hold the project name and type.

Raises

  • ProjectNotFoundError: When no settings file is found.