read_config

nbreport.userconfig.read_config(path=None)

Read an existing nbreport YAML-formatted configuration file.

Parameters:

path : str or pathlib.Path, optional

An optional, user-provided, override of the default configuration file path. The default path is ~/.nbreport.yaml.

Returns

——

config : ruamel.yaml.comments.CommentedMap

The configuration data, as a native ruamel.yaml map type.

Raises:

FileNotFoundError

Raised if the file does not exist.