get_base

get_base(key: str, ensure_exists: bool = True) → Path[source]

Get the base directory for a module.

Parameters:

  • key – The name of the module. No funny characters. The envvar <key>_HOME where key is uppercased is checked first before using the default home directory.

  • ensure_exists – Should all directories be created automatically? Defaults to true.

Returns:

The path to the given

Raises:

ValueError – if the key is invalid (e.g., has a dot in it)