cotede.utils.cotederc¶
- cotede.utils.cotederc(subdir=None)¶
Directory with custom configuration for CoTeDe
To keep the local environment tight, CoTeDe expects to find all local files, like pre-set QC procedures, in one single place. This function returns the path to that directory.
- Parameters:
subdir (str, optional) – Sub-directory inside the base custom directory.
- Returns:
A path to the local custom files.
The default path is a directory at the user’s home like:
~/.config/cotederc/
- Return type:
str
Note
That default path can be modified by defining the environment variable COTEDE_DIR. On bash that could be done like:
export COTEDE_DIR='/my/other/awesome/path/'
Note
For windows users the path is automatically adjusted to reflect its syntax.
Example
A sub-directory for configuration files, named ‘cfg’, can be determined by:
>>> cotederc('cfg')