Configs

cijoe configuration files are formated using YAML and named with suffix .config. In the core functionality of provided by cijoe, only the key transport has special meaning.

Keys are otherwise granted meaning by their use of Scripts, tests, and regular Python modules.

Example

…

Objects

Represented in the code as a Resources.

class cijoe.core.resources.Config(path: Path, pkg=None)

Encapsulation of a CIJOE config-file, e.g. ‘default-config.toml’

ivar: options: dict of configuration options populated by load() / from_path()

SUFFIX = '.toml'

content_from_file()

Load resource-content from ‘self.path’

static from_path(path, pkg=None)

Instantiate a Config from path, returning None on error

load()

Populates self.options on success. Returns a list of errors otherwise