cornsnake.config

Globally accessible config object. Can be configured by for example reading from command line arguments or TOML file (via tomllib), and then writing to the properties in-memory.

see util_toml.py for an example of reading from an ini file (TOML format).

Documentation

View Source

 1"""Globally accessible config object. Can be configured by for example reading from command line arguments or TOML file (via tomllib), and then writing to the properties in-memory.
 2
 3- see util_toml.py for an example of reading from an ini file (TOML format).
 4
 5[Documentation](http://docs.mrseanryan.cornsnake.s3-website-eu-west-1.amazonaws.com/cornsnake/config.html)
 6"""
 7
 8import logging
 9
10IS_VERBOSE = False
11PATH_TO_GIT = r"C:\Program Files\Git\cmd\git.exe"
12
13path_to_repo_dir = r"C:\src\github\my-repo"
14date_param = "2023-06-01"
15branches = ["main"]
16file_extensions = ""  # ".log,.zip,.js.map"
17
18blob_size = "512K"
19
20# SYSTEM CONFIG
21IS_COLOR_ENABLED = True
22IS_INTERACTIVE = (
23    False  # Normally True. Set to False for 'hands free' mode for automation
24)
25LOGGING_LEVEL = logging.INFO
26LOG_FILENAME = "my-log.log"
27MINIMIZE_PROGRESS_BAR_OUTPUT = (
28    False  # Normally False. Set to True for CI/CD build or other log-first environment.
29)

IS_VERBOSE = False

PATH_TO_GIT = 'C:\\Program Files\\Git\\cmd\\git.exe'

path_to_repo_dir = 'C:\\src\\github\\my-repo'

date_param = '2023-06-01'

branches = ['main']

file_extensions = ''

blob_size = '512K'

IS_COLOR_ENABLED = True

IS_INTERACTIVE = False

LOGGING_LEVEL = 20

LOG_FILENAME = 'my-log.log'

MINIMIZE_PROGRESS_BAR_OUTPUT = False