Plugins
========

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

Events
------
The following events are emitted:

#. :py:class:`canvas_core.plugins.PluginInitialized`

#. :py:class:`canvas_core.plugins.PluginInitializationFailed`


Plugins Structure
-----------------

Every plugin should follow the following structure:

.. code-block::

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

.. automodule:: canvas_core.plugins
    :members: