Create a Plugin

The quickest way to start is from the plugin template:

git clone https://github.com/promi4s/plugin-template.git
cd plugin-template

Install the dependencies (we recommend uv):

uv sync

Most of your work happens in plugin.py. See Plugin Structure for the expected package layout.

The Plugin Class

Plugins are defined by a single plugin class that inherits from the Plugin base class provided by the Ocelescope Python package.

A plugin class contains:

• Metadata (e.g., label, description, version) that is displayed in the frontend’s plugin interface.
• Runnable functions (plugin methods) that can be invoked from within Ocelescope.

Each plugin package must export exactly one plugin class via its __init__.py.

An example plugin

plugin.py

from ocelescope import OCEL, PetriNet, Plugin, plugin_method

class DiscoveryPlugin(Plugin):
    label = "Discovery Plugin"
    description = "An Ocelescope plugin"
    version = "1.0.0"

    @plugin_method(
        label="Discover Petri Net",
        description="Discover an object-centric Petri net",
    )
    def discover_ocpn(self, ocel: OCEL) -> PetriNet: ...

__init__.py

from .plugin import DiscoveryPlugin

__all__ = [
    "DiscoveryPlugin",
]

• The class name (DiscoveryPlugin) is the unique name of your plugin and helps distinguish it from other plugins.
• The label is what will be shown in the UI.
• The description briefly explains what your plugin does.
• The version lets you update your plugin over time.

Once you have a plugin class, the next step is to add Functions that can be run from Ocelescope.