Note

This is a public alpha release, and therefore features and functionality may change and the software and documentation may contain technical bugs or other issues. If you discover any issues please consider registering a GitHub issue.

core.plugin module

This module contains functionality for configurable plugins.

class core.plugin.Plugin(name, bases, attrs)[source]

Bases: abc.ABCMeta

Metaclass for plugin components.

The base class for each type of plugin should use this metaclass.

get_plugin(class_name: str) → Type[CT_co][source]

Get a plugin class by name.

Parameters:class_name – Name of plugin class
Returns:Plugin class
static load_plugins(plugin_dir: Union[str, pathlib.Path]) → None[source]

Load plugins from plugin directory.

Parameters:plugin_dir – Directory to search for plugins
plugin_choices