kentauros.modules package

Submodules

kentauros.modules.module module

This module contains the abstract PkgModule class, defines the methods all package modules must provide.

class kentauros.modules.module.PkgModule[source]

Bases: object

This abstract class defines the properties that all package modules must have.

__str__() → str[source]

This method is expected to produce a nice string describing the sub-module.

Returns:str – string containing a description of the sub-module
clean() → bool[source]

This method is expected to clean up a sub-module’s files and folders, if it creates any during its execution.

Returns:bool – boolean indicating whether cleaning up was successful
execute() → bool[source]

This method is expected to execute the package module and return a boolean, indicating whether the execution finished successfully or not.

Returns:bool – boolean indicating whether the execution was successful
imports() → dict[source]

This method is expected to return a dictionary of statistics about a module that has not yet been imported into the package database.

Returns:dict – dictionary containing the sub-module’s imported stats
status() → dict[source]

This method is expected to return a dictionary of statistics about this module.

Returns:dict – dictionary containing the sub-module’s exported stats
status_string() → str[source]

This method is expected to return a string describing the status of this module.

Returns:str – string containing module statistics
verify() → bool[source]

This method checks if all configuration values needed for this module are present and valid.

Returns:bool
boolean indicating whether the configuration / system verification completed
successfully

Module contents

This subpackage contains all plug-able kentauros modules.