Plugin Structure

Plugins are packaged as Python modules and distributed as .zip archives.

plugin.zip/
└── plugin/
    ├── __init__.py  # Entry point
    ├── plugin.py
    └── util/
        ├── discovery.py
        └── ...

The __init__.py file serves as the plugin’s entry point.

Available Templates

There are two ways to start a new plugin. For a full walkthrough of what to do once the project is set up, see the plugin tutorial.

The copier template asks a few questions (such as the plugin name) and generates a ready-to-use project with everything already renamed.

If you have uv installed, you can run copier without installing it:

uvx copier copy gh:promi4s/create-ocelescope-plugin my-plugin

copier copy gh:promi4s/create-ocelescope-plugin my-plugin

Replace my-plugin with the folder the project should be created in.

If you prefer not to use copier, start from the plugin template repository. Here you rename the plugin yourself afterwards.

Either clone it directly:

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

Or create your own repository from it on GitHub via Use this template → Create a new repository:

The plugin-template repository on GitHub with the "Use this template" menu opened, showing "Create a new repository".