Create a Plugin

Plugin Class

Implementation

To create a plugin that is able to connect to another service you have to first create a plugin class. This custom plugin class needs to inherit from kitovu.sync.syncplugin.AbstractSyncPlugin.

For an example implementation see kitovu.sync.plugin.smb.

Registration

The plugin class needs to be registered with stevedore.

You need to create a setup.py file like this:

from setuptools import setup

setup(
    # other setup parameters

    entry_points={
        'kitovu.sync.plugin': [
            'my-example = my.plugin:ExamplePlugin',
        ],
    },

    # other setup parameters
)

By setting entry_points you can list all plugins you implement in this package.

my-example

This is the name of the plugin used in the kitovu configuration.

my.plugin:ExamplePlugin

This is the namespace and class of the plugin to use.

For further information see the stevedore documentation for creating a plugin.

User Output

Errors

For errors happening in your plugin, you can raise kitovu.utils.PluginOperationError. If raised during configure, connect or list_path, the GUI/CLI shows an error and plugin is skipped entirely.

When raised in create_remote_digest, create_local_digest or retrieve_file, only the affected file is skipped.

Any other exception will lead to the kitovu application to terminate.

Warnings

To print warnings to the user without aborting the current operation, use Python’s logging framework. It’s recommended to use logger = logging.getLogger(__name__) to get an unique logger for your plugin.