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:
- Returns:
A path object representing the pystow home directory, as one of:
PYSTOW_HOME_ENVVAR
environment variable orThe user data directory defined by
appdirs
if thePYSTOW_USE_APPDIRS
environment variable is set totrue
orThe default directory constructed in the user’s home directory plus what’s returned by
get_name()
.