Kahi_plugins

Mono Repo for Kahi 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_run --generate_plugin myplugin

this is going to create a directory called *Kahi_myplugin

Anatomy of a plugin package

The packages have to have the next structure

Kahi_myplugin
kahi_myplugin/README.md
Kahi_myplugin/kahi_myplugin
Kahi_myplugin/kahi_myplugin/__init__.py
Kahi_myplugin/kahi_myplugin/kahi_myplugin.py
Kahi_myplugin/kahi_myplugin/_version.py
Kahi_myplugin/MANIFEST.in
Kahi_myplugin/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(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/kahi_myplugin/_version.py
• Lets go to https://github.com/colav/Kahi_plugins/releases and click in draf a new release
• Click in choose new tag and write Kahi_mypluigin/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_plugins/actions/workflows/kahi-plugin-publish.yml

Creating a plugin release

we have an script that allow to create a release for any plugin in the mono repo. This creates a new release for the plugin and updates the version of the plugin in the package kahi_impactu.

This requires to update the version of your plugin manually, and then run the script. The version on the package kahi_impactu have to be updated manually as well in Kahi_impactu/kahi_impact/_version.py, but the version in the Kahi_impactu/setup.py package is going to be updated automatically.

to use this script you have to run the next command using the main repository as working directory. (Kahi_plugins) USE THIS CAREFULLY!!

Check list before running the script:

• pip install git-python
• Clone the repository in your local git clone git@github.com:colav/Kahi_plugins.git
• Make your changes
• Update the version of your plugin in Kahi_myplugin/kahi_myplugin/_version.py
• Update the version of the package kahi_impactu in Kahi_impactu/kahi_impactu/_version.py Then run the next commands:

cd Kahi_plugins
.github/scripts/bump_kahi_impactu $PWD

It is still a bit manually but it will be more automatic in the future.

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! 😃.