Configuration
Configuration settings are explained here.
sleepecg.get_config(key=None)
Read SleepECG preferences from the configuration file.
For parameters not set in the user configuration file (~/.sleepecg/config.yml
), this
falls back to the default values defined in site-packages/sleepecg/config.yml
. See
configuration for a list of possible settings.
Parameters:
-
key
(str
) –The configuration key to look for. If
None
, all configuration settings are returned in a dictionary, by defaultNone
.
Returns:
-
Any
–The configuration value.
Source code in sleepecg/config.py
sleepecg.set_config(**kwargs)
Set SleepECG preferences and store them to the user configuration file.
If a value is None
, the corresponding key is deleted from the user configuration. See
configuration for a list of possible settings.
Parameters:
-
**kwargs
(Any
) –The configuration keys and values to set.
Examples: