Plugin reference¶
This document contains details about the base classes provided by configglue for writing plugins and plugin managers.
Plugin¶
- class Plugin¶
This is the base class from which your plugins should inherit in order to integrate with your configglue-enabled application.
- Plugin.schema¶
This is the schema class describing any configuration specific to your plugin.
By default a standard Schema is used.
- Plugin.enabled¶
Whether the plugin is enabled.
By default new plugins are disabled.
PluginManager¶
- class PluginManager¶
This is the base class from which any custom plugin managers should inherit.
- PluginManager.available¶
The list of currently available plugin classes.
- PluginManager.enabled¶
The list of currently enabled plugin classes.
- PluginManager.schemas¶
The list of schemas for the currently enabled plugins.
- PluginManager.enable(plugin)¶
Enable the plugin.
plugin is the plugin class.
- PluginManager.disable(plugin)¶
Disable the plugin.
plugin is the plugin class.
- PluginManager.register(plugin)¶
Register the plugin by adding it to the list of available plugins.
plugin is the plugin class.
- PluginManager.load()¶
Load plugins.
Return the list of classes for the loaded plugins.