settingsLib.py File Reference

[ FILE ] - Stash settings module. More...

Classes
class	sStash.settingsLib.PlatformName
	[ ENUM CLASS ] - Platform names. More...
class	sStash.settingsLib.PrintColor
	[ ENUM CLASS ] - Print colors. More...

Namespaces
	sStash.settingsLib
	[ MODULE ] - Stash settings module.

Functions
Project & Package Settings
def	sStash.settingsLib.getProjectsPath (platformName, projectName=MASTER_PROJECT_NAME)
	Get absolute path of projects. More...
def	sStash.settingsLib.getDevelopmentPackagesPath (projectName, developerName, developmentEnvName, platformName, create=False)
	Get development packages path. More...
def	sStash.settingsLib.getStagePackagesPath (projectName, developerName, stageEnvName, platformName)
	Get stage packages path. More...
def	sStash.settingsLib.getProjectPackagesPath (projectName, platformName)
	Get project packages path. More...
def	sStash.settingsLib.getMasterProjectPackagesPath (platformName)
	Get master project packages path. More...
File Settings
def	sStash.settingsLib.getLogFilePath (projectName, userName, platformName)
	Get absolute path of log file. More...
def	sStash.settingsLib.getEnvResetScriptFilePath (projectName, developerName, developmentEnvName, stageEnvName, platformName)
	Get absolute path of a script which would reset the environment before Stash environment is initialized. More...
def	sStash.settingsLib.getAppFilePath (projectName, developerName, developmentEnvName, stageEnvName, platformName, app)
	Get app file absolute path. More...
def	sStash.settingsLib.getCallbackModulePath (projectName, developerName, developmentEnvName, stageEnvName, platformName)
	Get absolute path of Stash callback Python module. More...
def	sStash.settingsLib.getPackageSettingsModulePath (projectName, developerName, developmentEnvName, stageEnvName, platformName)
	Get absolute path of Stash package settings Python module. More...
def	sStash.settingsLib.getScriptFilePath (projectName, userName, developmentEnvName, stageEnvName, platformName)
	Get absolute path of script file . More...
Color Settings
def	sStash.settingsLib.getTerminalHeaderDisplayColors (platformName)
	Get terminal header display colors. More...
def	sStash.settingsLib.getTerminalDisplayColors (platformName)
	Get terminal display colors. More...

Variables
string	sStash.settingsLib.IS_WINDOWS = 'Windows'
	[ bool ] - Whether the platform is Windows. More...
Environment Variables
Following attributes are not used by the executable but they are used by other Python packages.
string	sStash.settingsLib.STASH_APP_NAME = 'STASH_APP_NAME'
	[ str ] - App name environment variable. More...
string	sStash.settingsLib.STASH_APP_PATH = 'STASH_APP_PATH'
	[ str ] - App path environment variable. More...
string	sStash.settingsLib.STASH_COMMAND = 'STASH_COMMAND'
	[ str ] - Stash command environment variable. More...
string	sStash.settingsLib.STASH_DEVELOPER_NAME = 'STASH_DEVELOPER_NAME'
	[ str ] - Developer name environment variable. More...
string	sStash.settingsLib.STASH_DEVELOPMENT_ENV_NAME = 'STASH_DEVELOPMENT_ENV_NAME'
	[ str ] - Development environment name environment variable. More...
string	sStash.settingsLib.STASH_DEVELOPMENT_PACKAGES_PATH = 'STASH_DEVELOPMENT_PACKAGES_PATH'
	[ str ] - Development environment packages path environment variable. More...
string	sStash.settingsLib.STASH_INITIALIZE_IN_PLACE = 'STASH_INITIALIZE_IN_PLACE'
	[ str ] - Stash initialize in place environment variable. More...
string	sStash.settingsLib.STASH_MASTER_PROJECT_NAME = 'STASH_MASTER_PROJECT_NAME'
	[ str ] - Master project name environment variable. More...
string	sStash.settingsLib.STASH_MASTER_PROJECT_PACKAGES_PATH = 'STASH_MASTER_PROJECT_PACKAGES_PATH'
	[ str ] - Master project packages path environment variable. More...
string	sStash.settingsLib.STASH_MASTER_PROJECT_PATH = 'STASH_MASTER_PROJECT_PATH'
	[ str ] - Master project path environment variable. More...
string	sStash.settingsLib.STASH_MASTER_PROJECT_ROOT_PATH = 'STASH_MASTER_PROJECT_ROOT_PATH'
	[ str ] - Master project root path environment variable. More...
string	sStash.settingsLib.STASH_PROJECT_NAME = 'STASH_PROJECT_NAME'
	[ str ] - Project name environment variable. More...
string	sStash.settingsLib.STASH_PROJECT_PACKAGES_PATH = 'STASH_PROJECT_PACKAGES_PATH'
	[ str ] - Project packages path environment variable. More...
string	sStash.settingsLib.STASH_PROJECT_PATH = 'STASH_PROJECT_PATH'
	[ str ] - Project path environment variable. More...
string	sStash.settingsLib.STASH_PROJECT_ROOT_PATH = 'STASH_PROJECT_ROOT_PATH'
	[ str ] - Project root path environment variable. More...
string	sStash.settingsLib.STASH_PYTHON_EXECUTABLE_PATH = 'STASH_PYTHON_EXECUTABLE_PATH'
	[ str ] - Stash Python executable path environment variable. More...
string	sStash.settingsLib.STASH_PYTHON_VERSION = 'STASH_PYTHON_VERSION'
	[ str ] - Stash Python version environment variable. More...
string	sStash.settingsLib.STASH_STAGE_ENV_NAME = 'STASH_STAGE_ENV_NAME'
	[ str ] - Stage environment name environment variable. More...
string	sStash.settingsLib.STASH_STAGE_PACKAGES_PATH = 'STASH_STAGE_PACKAGES_PATH'
	[ str ] - Stage environment packages path environment variable. More...
string	sStash.settingsLib.STASH_USE_DEFAULT_PYTHON_INTERPRETER = 'STASH_USE_DEFAULT_PYTHON_INTERPRETER'
	[ str ] - Stash use default Python interpreter environment variable. More...
string	sStash.settingsLib.STASH_USE_PROJECT_APPS_ONLY = 'STASH_USE_PROJECT_APPS_ONLY'
	[ str ] - Stash use project apps only environment variable. More...
string	sStash.settingsLib.STASH_VERSION = 'STASH_VERSION'
	[ str ] - Stash version environment variable. More...
Static Settings
string	sStash.settingsLib.MASTER_PROJECT_NAME = 'master'
	[ str ] - Name of the master project. More...

Detailed Description

[ FILE ] - Stash settings module.