templates/runner6python/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 D-Bus activation service file to their appropriate locations.
0006 This way the Python script gets executed when KRunner requests matches and it does not need to be autostarted.
0007
0008 ```bash
0009 mkdir -p ~/.local/share/krunner/dbusplugins/
0010 cp %{APPNAMELC}.desktop ~/.local/share/krunner/dbusplugins/
0011 kquitapp6 krunner
0012 python3 %{APPNAMELC}.py
0013 ```
0014
0015 After that you should see your runner when typing `hello` in KRunner.
0016
0017 More information regarding the D-Bus API can be found here:
0018
0019 * https://invent.kde.org/frameworks/krunner/-/blob/master/src/data/org.kde.krunner1.xml
0020 * https://develop.kde.org/docs/features/d-bus/introduction_to_dbus/
0021
0022
0023 If you feel confident about your runner you can upload it to the KDE Store https://store.kde.org/browse?cat=628&ord=latest.