Settings

Settings can be configured in the config file under the settings key, or overridden at run time with one or more -s/--setting flags using dotted paths. Values are parsed as YAML, so 3 is an integer, true is a boolean, and so on. Dashes in key segments are normalized to underscores, so sub-second-digits and sub_second_digits are equivalent:

synth -s timestamps.sub-second-digits=3 -s timestamps.include-date=true

• Settings object
  • timestamps object (Default: None)
    • sub second digits integer (Default: 0) ○ The number of sub-second digits to show in timestamps (0-6).
    • include date boolean (Default: False) ○ If true, include the date (YYYY-MM-DD) in timestamps.
  • dot_env object (Default: None) ○ Controls loading of .env files using python-dotenv.
    • load boolean (Default: True) ○ If true, load environment variables from the file.
    • file string (Default: '.env') ○ Path to the .env file to load, relative to the config file.

Timestamps

• Timestampsettings object
  • sub second digits integer (Default: 0) ○ The number of sub-second digits to show in timestamps (0-6).
  • include date boolean (Default: False) ○ If true, include the date (YYYY-MM-DD) in timestamps.

.env

• Dotenvsettings object ○ Controls loading of .env files using python-dotenv.
  • load boolean (Default: True) ○ If true, load environment variables from the file.
  • file string (Default: '.env') ○ Path to the .env file to load, relative to the config file.