Development/Tutorials/Plasma4/Python/GettingStarted

Abstract

In this tutorial we'll cover setting up a very simple plasma applet in Python, and how to install it and run it, basically the edit, install, run and debug cycle. To follow this you will need to have KDE 4.2 or later installed, and also the python support for plasma and related dependencies. I'm going to assume that you are using a unix-style operating system such as Linux of *BSD and aren't adverse to the shell.

Project Structure

The first step for any software project is to set up your project's directory on disk. For this tutorial we are going to create a very simple “hello-python” applet. Create a directory on somewhere called “hello-python” which in turn contains a “content” directory which then contains a “code” directory. This command below will do all this.

 mkdir -p hello-python/content/code

This creates a simple directory structure which also matches the package structure expect by the “plasmapkg” command. More on this later.

Metadata.desktop

In the “hello-python” directory create a file called “metadata.desktop” and open it in your text editor. Copy the following code into metadata.desktop.

 [Desktop Entry]
 Encoding=UTF-8
 Name=Hello Python
 Name[nl]=Hallo Python
 Type=Service
 ServiceTypes=Plasma/Applet
 Icon=chronometer
 X-Plasma-API=python
 X-Plasma-MainScript=code/main.py
 X-KDE-PluginInfo-Author=Simon Edwards
 [email protected]
 X-KDE-PluginInfo-Name=hello-python
 X-KDE-PluginInfo-Version=1.0
 X-KDE-PluginInfo-Website=http://plasma.kde.org/
 X-KDE- PluginInfo-Category=Examples
 X-KDE- PluginInfo-Depends=
 X-KDE- PluginInfo-Depends=GPL
 X-KDE- PluginInfo-EnabledByDefault=true

This “metadata.desktop” file list important information needed by Plasma to load the applet, and also information about what the applet is and who created it. The “Name” field lists the name of the applet. This field can also be listed multiple times as different translations. Here I've just given a Dutch translation of the name. The “[nl]” indicates the language of the field.

The “Type” and “ServiceType” fields identify what kind of thing this desktop file is describing. Here we say that we have a plasma applet.

The “Icon” field gives the name of the icon to associate with this applet. The icon is typically shown in things such as the “Add widget” dialog in Plasma.

The “X-Plasma-API” and “X-Plasma-MainScript” fields are used specifically by Plasma to find the correct script-engine to use when loading and running the applet.

Most of the “X-KDE-PluginInfo-*” fields give extra information about who created the applet. “X-KDE- PluginInfo-Category” lists a category which this applet belong to. http://techbase.kde.org/Projects/Plasma/PIG has a list of acceptable category names.

Main script

Create a file in the content/code called main.py, open it up in your text editor and put this code in it and save it.

 # <Copyright and license information goes here.>
 from PyQt4.QtCore import *
 from PyQt4.QtGui import *
 from PyKDE4.plasma import Plasma
 from PyKDE4 import plasmascript

 class HelloPython(plasmascript.Applet):
     def __init__(self,parent,args=None):
         plasmascript.Applet.__init__(self,parent)

     def init(self):
         self.setHasConfigurationInterface(False)
         self.resize(125, 125)
         self.setAspectRatioMode(Plasma.Square)

     def paintInterface(self, painter, option, rect):
         painter.save()
         painter.setPen(Qt.white)
         painter.drawText(rect, Qt.AlignVCenter | Qt.AlignHCenter, "Hello Python!")
         painter.restore()

 def CreateApplet(parent):
     return HelloPython(parent)

This is basically the simplest applet which actually does something. The code starts out with the usual copyright notice and license information which I've actually left out for now.

Next up is a bunch of imports. The Python support in Plasma is an extension of PyQt and PyKDE. So here we pull in a couple of PyQt and PyKDE modules which we will need. There are two plasma related modules which we use. The first, PyKDE4.plasma, are the bindings straight on top of the Plasma C++ API. This gives us access to most of the APIs we need, but not all. To create applets which can be packaged and delivered to users across the network via KDE's Get Hot New Stuff (GHNS) framework, we need to use some extra Python specific classes which are in PyKDE4.plasmascript.

Now we define our main applet class. This is our Hello Python applet and it must be a subclass of plasma.Applet. In the __init__() method we need to make sure that we give the super class constructor a chance to run. Note that it is recommended to put most of the initialisation code inside the init() method and not in the __init__(). After Plasma has constructed and initialised the applet, Plasma will call the init() method on the applet to let it continue setting itself up. Our init() method is rather short. We just tell Plasma that we don't have a configuration dialog and we set up the initial size of the applet.

The paintInterface() method is where we draw our “Hello Python” message. First we save the state / settings of the given QPainter object by calling save(). Then we set the color to white and use drawText() to draw our message. Finally we call restore() which resets the Qpainter settings back to how it was when paintInterface() was called.

The CreateApplet() function is needed to create an instance of our applet. When Plasma loads a Python based applet it will expect there to be a CreateApplet() function which it will call. The task of the CreateApplet() function is to create and instance of the applet and pass it back to Plasma.

Packaging, installing & running

Plasma applets can be packaged in zip files and installed using the “plasmapkg” command line tool. The directory structure which we have used for our project matches that need in the zip file. All we have to do is zip it update. Run the following command from inside the hello-python directory.

 zip -r ../hello-python.zip .

This will create the hello-python.zip file in the directory just above the hello-python directory. Go to this directory in the shell and run this plasmapkg command to install our little hello-python applet.

 plasmapkg -i hello-python.zip

This installs the applet into your home directory. Now we can run it. When developing applets it is more convenient to use the “plasmoidviewer”. This is a little utility which displays an applet in a window instead of you having to use your desktop. This command below will run our applet.

 plasmoidviewer hello-python

You should now be able to see the fruits of your labor.

To uninstall our applet we use plasmapkg again with its -r option.

 plasmapkg -r hello-python

Conclusion

This tutorial covers very basics of developing Plasma applets using Python. Most of the material discussed here is boring but important “boilerplate” stuff which stays mostly the same between every applet project. In future tutorials we can move on to move exciting things than just displaying a single line of static text.