get_home

get_home(ensure_exists=True)[source]

Get the PyStow home directory.

Parameters:

ensure_exists (bool) – If true, ensures the directory is created

Return type:

Path

Returns:

A path object representing the pystow home directory, as one of:

  1. PYSTOW_HOME_ENVVAR environment variable or

  2. The user data directory defined by appdirs if the PYSTOW_USE_APPDIRS environment variable is set to true or

  3. The default directory constructed in the user’s home directory plus what’s returned by get_name().