mMecoSettings - Settings


Meco™ provides a Python module mMecoSettings.settingsLib where you can change settings based on your production pipeline requirements. You do not need to invoke any of the functions in settings module. Meco™ will invoke them automatically and provide the required arguments appropriately when needed. Settings module contains built-in example, which would guide you in your custom settings implementations.

None of the functions in the module need to be edited unless Meco Ecosystem™ folder structure under meco folder is changed.

Function Arguments

The following arguments are passed to the relevant settings functions automatically by Meco™ when appropriate. You can implement each setting function by using these arguments and determine conditions based on their values. An argument value will be None if it not available/not provided/not applicable.

platformName

Type: str

Name of the current platform, one of the following values: Darwin, Linux, Windows

projectName

Type: str

Name of the project in use.

developerName

Type: str

Name of the developer, which development or stage environment will be initialized for.

developmentEnvName

Type: str

Development environment name that will be initialized.

stageEnvName

Type: str

Stage environment name that will be initialized.

Functions

getProjectsPath

Return Type: str

Get absolute path of projects.

getProjectRootPath

Return Type: str

Get absolute path of given project.

getReservedPackagesPath

Return Type: str

Get reserved packages path.

getDevelopmentPackagesPath

Return Type: str

Get development packages path.

getStagePackagesPath

Return Type: str

Get stage packages path.

getProjectInternalPackagesPath

Return Type: str

Get project internal packages path.

getProjectExternalPackagesPath

Return Type: str

Get project external packages path.

getMasterProjectInternalPackagesPath

Return Type: str

Get master project internal packages path.

getMasterProjectExternalPackagesPath

Return Type: str

Get master project external packages path.

getLogFilePath

Return Type: str

Get absolute path of a log file.

getAppFilePath

Return Type: str

Get absolute path of an app file.

getScriptFilePath

Return Type: str

Get absolute path of a script file

getTerminalHeaderDisplayColors

Return Type: list of str

Get terminal header display colors.

getTerminalDisplayColors

Return Type: dict

Get terminal display colors.

Examples

You can check mMecoSettings.settingsLib at mMecoSettings/python/mMecoSettings/settingsLib.py for example implementations.

API Reference

mMecoSettings.settingsLib API Reference