tlcconfig.default_locations

Module Contents

Functions

Function	Description
get_default_root_dir	Return the default root directory. This directory has a “projects” subdir that contains 3LC projects.
get_default_log_dir	Return the default log root directory.
get_default_config_dir	Return the default config file directory.

Data

Data	Description
TLC_DEFAULT_ROOT_DIR_ENV

API

tlcconfig.default_locations.TLC_DEFAULT_ROOT_DIR_ENV = get(...)

tlcconfig.default_locations.get_default_root_dir() → str

Return the default root directory. This directory has a “projects” subdir that contains 3LC projects.

This function is platform dependent, and the default is platform dependent:

• Linux: $HOME/.local/share/3LC/ or $XDG_DATA_HOME/3LC/

• macOS: $HOME/Library/Application Support/3LC/

• Windows: %LOCALAPPDATA%\3LC\3LC\

Returns:

The default root directory.

tlcconfig.default_locations.get_default_log_dir() → str

Return the default log root directory.

This function is platform dependent, and the default is platform dependent:

• Linux: $HOME/.local/state/3LC/log or $XDG_STATE_HOME/3LC/log

• macOS: $HOME/Library/Logs/3LC/Logs

• Windows: %LOCALAPPDATA%\3LC\3LC\Logs

Returns:

The default log root directory.

tlcconfig.default_locations.get_default_config_dir() → str

Return the default config file directory.

This function is platform dependent, and the default is platform dependent:

• Linux: $HOME/.config/3LC or $XDG_CONFIG_HOME/3LC

• macOS: $HOME/Library/Application Support/3LC

• Windows: %LOCALAPPDATA%\3LC\3LC

Returns:

The default config file directory.