templates/runnerpython/README.md

0001 ### %{APPNAME}
0002
0003 This plugin provides a simple template for a KRunner plugin using dbus.
0004
0005 The install script copies the Krunner config file and a dbus activation service file
0006 to their appropriate locations.
0007 This way the python script gets executed when KRunner
0008 requests matches and it does not need to be autostarted.
0009
0010 If you want to run the plugin manually to debug it you can do the following:
0011 ```bash
0012 mkdir -p ~/.local/share/kservices5/krunner/dbusplugins/
0013 cp plasma-runner-%{APPNAMELC}.desktop ~/.local/share/kservices5/krunner/dbusplugins/
0014 kquitapp5 krunner
0015 python3 %{APPNAMELC}.py
0016 ```
0017
0018 After that you should see your runner when typing `hello` in KRunner.
0019
0020 More information can be found here:
0021 https://invent.kde.org/frameworks/krunner/-/blob/master/src/data/org.kde.krunner1.xml
0022 https://techbase.kde.org/Development/Tutorials/D-Bus/Introduction
0023
0024
0025 If you feel confident about your runner you can upload it to the KDE Store
0026 https://store.kde.org/browse/cat/628/order/latest/.