How To Create A Plugin

If you want to create and use a new providerplugin, you need to implement a new provider class.

First you need to create a new file for the plugin <plugin_name>.py. It is important that the file has the extension .py.

Writing the code for the plugin provider is analogous to writing a provider. Please refer to the guide on creating a provider for a full explanation.

Important

There is one important difference between a built-in provider and a plugin:

A plugin must use full imports from cata_log.providers while a built-in provider can import from . .

Provider:

from .base import Provider

Plugin:

from cata_log.providers.base import Provider

After you have written the code for the plugin, you can test it manually by adding it to your local Cata-Log instance.

See the plugin instruction for more details on how to do that.