diplomat.core_ops.yaml

diplomat.core_ops.yaml(run_config: PathLike | str | None = None, **extra_args) → None[source]

Run DIPLOMAT based on a passed yaml run script. The yaml script should include a ‘command’ key specifying the DIPLOMAT sub-command to run and an ‘arguments’ key specifying the list of arguments (key-value pairs) to pass to the command.

Parameters:

run_config – The path to the YAML configuration file to use to configure the running of DIPLOMAT. If this value is not specified or is None, read the yaml from standard output.
extra_args – Any additional arguments (if the CLI, flags starting with ‘–’) are passed to the selected command, as specified in the YAML file. Additional arguments passed with the same name as ones found in the YAML file will overwrite the values found in the YAML file.

Returns:

Returns the value returned by the selected diplomat command.