README.md

Kahi_sample

Mono Repo for Kahi Sample Plugins

Table of Contents

• Plugin explanation
• Anatomy of a plugin package
• Creating a plugin release
• Creating a plugin release using Bump
• Final remarks

Plugin explanation

This repository allows to host all plugins for Kahi. The directory kahi_template is a template project to with a basic example, every project works as a python package and the kahi plugin system works by name convention see (python plugin docs) in our case the name prefix is Kahi_

Instead copying the folder kahi_template, you can run the next command to create you new plugin directory.

kahi_generate --plugin myplugin_sample

this is going to create a directory called *Kahi_myplugin_sample

Anatomy of a plugin package

The packages have to have the next structure

Kahi_myplugin_sample
kahi_myplugin_sample/README.md
Kahi_myplugin_sample/kahi_myplugin_sample
Kahi_myplugin_sample/kahi_myplugin_sample/__init__.py
Kahi_myplugin_sample/kahi_myplugin_sample/kahi_myplugin_sample.py
Kahi_myplugin_sample/kahi_myplugin_sample/_version.py
Kahi_myplugin_sample/MANIFEST.in
Kahi_myplugin_sample/setup.py

The plugin have to be child class of KahiBase, in the template you will find a file kahi_myplugin.py with a class Kahi_myplugin, as example.

The parameters for configuration have to be defined right before the class as class variable or class attribute see (python doc)

from kahi.KahiBase import KahiBase

class Kahi_myplugin_sample(KahiBase):
    # class implementation

Creating a plugin release

We have a github action that allow to create a release for any plugin in the mono repo.

• The first thing is to update the version of your plugin on Kahi_myplugin_sample/kahi_myplugin_sample/_version.py
• Lets go to https://github.com/colav/Kahi_sample/releases and click in draf a new release
• Click in choose new tag and write Kahi_mypluigin_sample/v0.0.x name of your plugin slash the version of your plugin
• Write the release notes
• click on publish relase

Now the github action will be activate and you can check the status of you package herehttps://github.com/colav/Kahi_sample/actions/workflows/kahi-sample-publish.yml

Final remarks

• You can take a look in the already developed plugins to have examples or get inspiration for your plugins.
• Remember write elegant documentation for your plugins.
• if you need help please open an issue.

Made with love ❤️ by Colav Team! 😃.