generate_config_file.py
Configure cli to run based on a YAML configuration file.
- ts_backend_check.cli.generate_config_file.path_exists(path: str) bool[source]
Check if path entered by the user exists withing the filesystem.
- Parameters:
- pathstr
Path should be entered as a string from the user.
- Returns:
- bool
Return true or false based on if path exists.
- ts_backend_check.cli.generate_config_file.config_file_validation(config: dict) bool[source]
Validate the configuration file for ts-backend-check to ensure it has the necessary keys, values and types.
- Parameters:
- configdict
The configuration file to validate.
- Returns:
- bool
True if the configuration file is valid. False otherwise.
- ts_backend_check.cli.generate_config_file.config_file_is_valid() bool[source]
Check that the configuration file for ts-backend-check is not empty and has the necessary keys.
- Returns:
- bool
True if the ts-backend-check configuration file is valid. False otherwise.
- ts_backend_check.cli.generate_config_file.write_config(config: dict[str, dict[str, object]]) None[source]
Function to write into .ts-backend-check.yaml file.
- Parameters:
- configdict[str, dict[str, object]]
Passing a dictionary as key str with another dict as value.