polaris.yaml.PolarisYaml.read

classmethod PolarisYaml.read(filename, package=None, replacements=None)[source]

Add config options from a yaml file

Parameters

filename (str) – A template yaml config file
package (str, optional) – The name of a package the filename is found in
replacements (dict, optional) – A dictionary of replacements, which, if provided, is used to replace Jinja variables and the yaml file is assumed do be a Jinja template

Returns

yaml (polaris.yaml.PolarisYaml) – A yaml object read in from the given file (and optionally package)