Plugins

The Plugins API is responsible for managing plugins in the system.

Events

The following events are emitted:

canvas_core.plugins.PluginInitialized
canvas_core.plugins.PluginInitializationFailed

Plugins Structure

Every plugin should follow the following structure:

plugin-name/
├── plugin_name/
│   ├── __init__.py
│   └── plugin.py           # Add your plugin code here.
├── pyproject.toml
├── poetry.lock
└── README.md

Note

Only sdist (.zip or .tar.gz ) and wheel (.whl) distribution formats are supported.

API Reference

class canvas_core.plugins.PluginInitializationFailed(**attrs: Any): An event emitted after a plugin has failed to initialize.

class canvas_core.plugins.PluginInitialized(**attrs: Any): An event emitted after a plugin has been successfully initialized.