realtwin.util_lib.prepare_config_file

realtwin.util_lib.prepare_config_file(dest_dir: str = '') → bool[source]

Create a default/demo configuration file for the RealTwin package.

Parameters:: dest_dir (str) – save the configuration file to destination dir. Defaults to “”, which means the current working directory.

Example

>>> import realtwin as rt
>>> rt.create_configuration_file()  # will create a configuration file in the current working directory
>>> rt.create_configuration_file(dest_dir="path/to/directory")  # will create in the specified directory

Returns:: True if the configuration file is created successfully.
Return type:: bool