Python API¶

Cumin Python API autodoc.

Automation and orchestration framework written in Python.

exception cumin.CuminError[source]¶

Bases: Exception

Base Exception class for all Cumin's custom Exceptions.

cumin.trace(self, msg, *args, **kwargs)[source]¶

Additional logging level for development debugging.

class cumin.Config(config='/etc/cumin/config.yaml')[source]¶

Bases: dict

Singleton-like dictionary class to load the configuration from a given path only once.

Load the given configuration if not already loaded and return it.

Called by Python's data model for each new instantiation of the class.

Parameters:: config (str, optional) -- path to the configuration file to load.
Returns:: the configuration dictionary.
Return type:: dict

Examples

>>> import cumin
>>> config = cumin.Config()

cumin.parse_config(config_file)[source]¶

Parse the YAML configuration file.

Parameters:: config_file (str) -- the path of the configuration file to load.
Returns:: the configuration dictionary.
Return type:: dict
Raises:: CuminError -- if unable to read or parse the configuration.

cumin.nodeset(nodes=None)[source]¶

Instantiate a ClusterShell NodeSet with the resolver defaulting to RESOLVER_NOGROUP.

This allow to avoid any conflict with Cumin grammars.