Python API

Cumin Python API autodoc.

Automation and orchestration framework written in Python.

class cumin.Config

Bases: dict

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

static __new__(config='/etc/cumin/config.yaml')

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()

exception cumin.CuminError

Bases: exceptions.Exception

Base Exception class for all Cumin's custom Exceptions.

cumin.parse_config(config_file)

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.trace(self, msg, *args, **kwargs)

Additional logging level for development debugging.

Parameters:according to logging.Logger interface for log levels.

cumin.__version__ = '0.1.dev2+g0c369cf'

str -- the version of the current Cumin module.

Subpackages and Submodules

• Grammar
• Query
• Transport
• Backends
  • Direct
  • OpenStack
  • PuppetDB
• Transports
  • ClusterShell