Development/Tutorials/Plasma/Python/GettingStarted - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T20:54:09Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:45:19Z
Text replace - "<code>" to "<syntaxhighlight lang="text">"

				
				
				
				
			
			← Older revision
			Revision as of 20:45, 29 June 2011
			
Line 41:
Line 41:
    
  The <tt>Icon</tt> 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. If you want to use a custom icon, you can place it in the package root, along metadata.desktop, and then point to it like this:   The <tt>Icon</tt> 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. If you want to use a custom icon, you can place it in the package root, along metadata.desktop, and then point to it like this:
− <code>Icon=/mycustomicon.png</code> + <syntaxhighlight lang="text">Icon=/mycustomicon.png</code>
    
  The <tt>X-Plasma-API</tt> and <tt>X-Plasma-MainScript</tt> fields are used specifically by Plasma to find the correct script-engine to use when loading and running the applet.   The <tt>X-Plasma-API</tt> and <tt>X-Plasma-MainScript</tt> fields are used specifically by Plasma to find the correct script-engine to use when loading and running the applet.
Line 117:
Line 117:
    
  '''Error: '''   '''Error: '''
− <code>Installation of hello-python.zip failed.</code> + <syntaxhighlight lang="text">Installation of hello-python.zip failed.</code>
  '''Solution:''' enable more verbose output from plasmapkg. Run kdebugdialog:   '''Solution:''' enable more verbose output from plasmapkg. Run kdebugdialog:
− <code>kdebugdialog --fullmode</code> + <syntaxhighlight lang="text">kdebugdialog --fullmode</code>
  and enable the outputs for ''1209 libplasma''.   and enable the outputs for ''1209 libplasma''.
    
  '''Error: '''   '''Error: '''
− <code>plasmoidviewer(19580)/libplasma Plasma::Package::isValid: Could not find required file mainscript , look in "/home/user/.kde4/share/apps/plasma/plasmoids/kotnet-login/contents/code/main.py"</code> + <syntaxhighlight lang="text">plasmoidviewer(19580)/libplasma Plasma::Package::isValid: Could not find required file mainscript , look in "/home/user/.kde4/share/apps/plasma/plasmoids/kotnet-login/contents/code/main.py"</code>
  '''Solution:''' check that you have those files (you need a main.py) and that you don't have any wrong names.   '''Solution:''' check that you have those files (you need a main.py) and that you don't have any wrong names.
    
  '''Error: '''   '''Error: '''
− <code>Could not create a python scriptengine for "your package name"</code> + <syntaxhighlight lang="text">Could not create a python scriptengine for "your package name"</code>
  '''Solution:''' check if your plasma installation has the required files (plasma_importer.py, plasmascript.py) and the package python-dev is installed.   '''Solution:''' check if your plasma installation has the required files (plasma_importer.py, plasmascript.py) and the package python-dev is installed.
    
Line 137:
Line 137:
    
  '''Error: '''   '''Error: '''
− <code>ImportError: /usr/lib/python2.5/lib-dynload/select.so: undefined symbol: PyExc_ValueError</code> + <syntaxhighlight lang="text">ImportError: /usr/lib/python2.5/lib-dynload/select.so: undefined symbol: PyExc_ValueError</code>
  '''Solution:''' you probably have PyQt compiled against a different version of python than the one that is trying to run the code (python2.5 vs python2.6).   '''Solution:''' you probably have PyQt compiled against a different version of python than the one that is trying to run the code (python2.5 vs python2.6).
    
Line 143:
Line 143:
    
  '''Error: '''   '''Error: '''
− <code>This object could not be created for the following reason: Could not open the hello-python package required for the Hello Python widget.</code> + <syntaxhighlight lang="text">This object could not be created for the following reason: Could not open the hello-python package required for the Hello Python widget.</code>
  '''Solution:''' Follow the Tutorial closely. You need to create the following file structure:   '''Solution:''' Follow the Tutorial closely. You need to create the following file structure:
  <pre>   <pre>



Nicolas17: update to new syntaxhighlighter
2011-06-29T19:34:15Z
update to new syntaxhighlighter

				
				
				
				
			
			← Older revision
			Revision as of 19:34, 29 June 2011
			
Line 6:
Line 6:
    
  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 <tt>hello-python</tt> which in turn contains a <tt>contents</tt> directory which then contains a <tt>code</tt> directory. This command below will do all this.   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 <tt>hello-python</tt> which in turn contains a <tt>contents</tt> directory which then contains a <tt>code</tt> directory. This command below will do all this.
− <code bash> + <syntaxhighlight lang="bash">
  mkdir -p hello-python/contents/code   mkdir -p hello-python/contents/code
− </code> + </syntaxhighlight>
  This creates a simple directory structure which also matches the package structure expected by the <tt>plasmapkg</tt> command. More on this later.   This creates a simple directory structure which also matches the package structure expected by the <tt>plasmapkg</tt> command. More on this later.
    
Line 15:
Line 15:
  In the <tt>hello-python</tt> directory create a file called <tt>metadata.desktop</tt> and open it in your text editor. Copy the following code into <tt>metadata.desktop</tt>.   In the <tt>hello-python</tt> directory create a file called <tt>metadata.desktop</tt> and open it in your text editor. Copy the following code into <tt>metadata.desktop</tt>.
    
− <code ini> + <syntaxhighlight lang="ini">
  [Desktop Entry]   [Desktop Entry]
  Encoding=UTF-8   Encoding=UTF-8
Line 34:
Line 34:
  X-KDE-PluginInfo-License=GPL   X-KDE-PluginInfo-License=GPL
  X-KDE-PluginInfo-EnabledByDefault=true   X-KDE-PluginInfo-EnabledByDefault=true
− </code> + </syntaxhighlight>
    
  This <tt>metadata.desktop</tt> file list important information needed by Plasma to load the applet, and also information about what the applet is and who created it. The <tt>Name</tt> 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 <tt>[nl]</tt> indicates the language of the field.   This <tt>metadata.desktop</tt> file list important information needed by Plasma to load the applet, and also information about what the applet is and who created it. The <tt>Name</tt> 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 <tt>[nl]</tt> indicates the language of the field.
Line 51:
Line 51:
  Create a file in the <tt>contents/code</tt> directory called <tt>main.py</tt>, open it up in your text editor and put this code in it and save it.   Create a file in the <tt>contents/code</tt> directory called <tt>main.py</tt>, open it up in your text editor and put this code in it and save it.
    
− <code python> + <syntaxhighlight lang="python">
  # -*- coding: utf-8 -*-   # -*- coding: utf-8 -*-
  # <Copyright and license information goes here.>   # <Copyright and license information goes here.>
Line 75:
Line 75:
  def CreateApplet(parent):   def CreateApplet(parent):
       return HelloPython(parent)        return HelloPython(parent)
− </code> + </syntaxhighlight>
    
  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.   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.
Line 90:
Line 90:
    
  Plasma applets can be packaged in zip files and installed using the <tt>plasmapkg</tt> 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.   Plasma applets can be packaged in zip files and installed using the <tt>plasmapkg</tt> 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.
− <code bash> + <syntaxhighlight lang="bash">
  zip -r ../hello-python.zip .   zip -r ../hello-python.zip .
− </code> + </syntaxhighlight>
  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 <tt>plasmapkg</tt> command to install our little hello-python applet.   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 <tt>plasmapkg</tt> command to install our little hello-python applet.
− <code bash> + <syntaxhighlight lang="bash">
  plasmapkg -i hello-python.zip   plasmapkg -i hello-python.zip
− </code> + </syntaxhighlight>
  This installs the applet into your home directory. Now we can run it. When developing applets it is more convenient to use the <tt>plasmoidviewer</tt>. 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.   This installs the applet into your home directory. Now we can run it. When developing applets it is more convenient to use the <tt>plasmoidviewer</tt>. 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.
− <code bash> + <syntaxhighlight lang="bash">
  plasmoidviewer hello-python   plasmoidviewer hello-python
− </code> + </syntaxhighlight>
  You should now be able to see the fruits of your labor.   You should now be able to see the fruits of your labor.
    
  To uninstall our applet we use <tt>plasmapkg</tt> again with its -r option.   To uninstall our applet we use <tt>plasmapkg</tt> again with its -r option.
− <code bash> + <syntaxhighlight lang="bash">
  plasmapkg -r hello-python   plasmapkg -r hello-python
− </code> + </syntaxhighlight>
    
  == Conclusion ==   == Conclusion ==
Line 145:
Line 145:
  <code>This object could not be created for the following reason: Could not open the hello-python package required for the Hello Python widget.</code>   <code>This object could not be created for the following reason: Could not open the hello-python package required for the Hello Python widget.</code>
  '''Solution:''' Follow the Tutorial closely. You need to create the following file structure:   '''Solution:''' Follow the Tutorial closely. You need to create the following file structure:
− <code> + <pre>
  /hello-python/   /hello-python/
  /hello-python/metadata.desktop   /hello-python/metadata.desktop
Line 151:
Line 151:
  /hello-python/contents/code/   /hello-python/contents/code/
  /hello-python/contents/code/main.py   /hello-python/contents/code/main.py
− </code> + </pre>



GiacomoL: added details on packaging custom icon
2010-10-19T20:51:23Z
added details on packaging custom icon

				
				
				
				
			
			← Older revision
			Revision as of 20:51, 19 October 2010
			
Line 40:
Line 40:
  The <tt>Type</tt> and <tt>ServiceType</tt> fields identify what kind of thing this desktop file is describing. Here we say that we have a plasma applet.   The <tt>Type</tt> and <tt>ServiceType</tt> fields identify what kind of thing this desktop file is describing. Here we say that we have a plasma applet.
    
− The <tt>Icon</tt> 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 <tt>Icon</tt> 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. If you want to use a custom icon, you can place it in the package root, along metadata.desktop, and then point to it like this:
  + <code>Icon=/mycustomicon.png</code>
    
  The <tt>X-Plasma-API</tt> and <tt>X-Plasma-MainScript</tt> fields are used specifically by Plasma to find the correct script-engine to use when loading and running the applet.   The <tt>X-Plasma-API</tt> and <tt>X-Plasma-MainScript</tt> fields are used specifically by Plasma to find the correct script-engine to use when loading and running the applet.



Phobie: /* Troubleshooting */ linkfix
2010-06-24T00:12:11Z
‎Troubleshooting:  linkfix

				
				
				
				
			
			← Older revision
			Revision as of 00:12, 24 June 2010
			
Line 131:
Line 131:
  Packages for openSUSE are available in the KDE:KDE4:Factory:Desktop repository (python-kdebase4 and python-devel).   Packages for openSUSE are available in the KDE:KDE4:Factory:Desktop repository (python-kdebase4 and python-devel).
    
− Source files: http://websvn.kde.org/trunk/KDE/kdebase/workspace/plasma/scriptengines/python/ + Source files: http://websvn.kde.org/trunk/KDE/kdebase/workspace/plasma/generic/scriptengines/python/
    
    



Phobie: /* Main script */ never use "from x import *"!
2010-06-24T00:05:15Z
‎Main script:  never use "from x import *"!

				
				
				
				
			
			← Older revision
			Revision as of 00:05, 24 June 2010
			
Line 51:
Line 51:
    
  <code python>   <code python>
  + # -*- coding: utf-8 -*-
  # <Copyright and license information goes here.>   # <Copyright and license information goes here.>
− from PyQt4.QtCore import * + from PyQt4.QtCore import Qt
− from PyQt4.QtGui import * + 
  from PyKDE4.plasma import Plasma   from PyKDE4.plasma import Plasma
  from PyKDE4 import plasmascript   from PyKDE4 import plasmascript





Tampakrap: Noted how to enable kWarning messages.
2009-08-07T18:26:47Z
Noted how to enable kWarning messages.

				
				
				
				
			
			← Older revision
			Revision as of 18:26, 7 August 2009
			
Line 114:
Line 114:
    
  == Troubleshooting ==   == Troubleshooting ==
  + 
  + '''Error: '''
  + <code>Installation of hello-python.zip failed.</code>
  + '''Solution:''' enable more verbose output from plasmapkg. Run kdebugdialog:
  + <code>kdebugdialog --fullmode</code>
  + and enable the outputs for ''1209 libplasma''.
    
  '''Error: '''   '''Error: '''



Tampakrap: typo
2009-06-18T19:44:22Z
typo

				
				
				
				
			
			← Older revision
			Revision as of 19:44, 18 June 2009
			
Line 1:
Line 1:
  == Abstract ==   == 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. + 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 or *BSD and aren't adverse to the shell.
    
  == Project Structure ==   == Project Structure ==



Einar: Update on the openSUSE packages
2009-04-04T07:51:23Z
Update on the openSUSE packages

				
				
				
				
			
			← Older revision
			Revision as of 07:51, 4 April 2009
			
Line 123:
Line 123:
  '''Solution:''' check if your plasma installation has the required files (plasma_importer.py, plasmascript.py) and the package python-dev is installed.   '''Solution:''' check if your plasma installation has the required files (plasma_importer.py, plasmascript.py) and the package python-dev is installed.
    
− Packages for Opensuse 11.1: http://download.opensuse.org/repositories/home:/pantsgolem:/branches:/KDE:/KDE4:/Factory:/Desktop/openSUSE_11.1/ + Packages for openSUSE are available in the KDE:KDE4:Factory:Desktop repository (python-kdebase4 and python-devel).
    
  Source files: http://websvn.kde.org/trunk/KDE/kdebase/workspace/plasma/scriptengines/python/   Source files: http://websvn.kde.org/trunk/KDE/kdebase/workspace/plasma/scriptengines/python/



Tampakrap at 20:37, 28 March 2009
2009-03-28T20:37:35Z


				
				
				
				
			
			← Older revision
			Revision as of 20:37, 28 March 2009
			
Line 9:
Line 9:
  mkdir -p hello-python/contents/code   mkdir -p hello-python/contents/code
  </code>   </code>
− This creates a simple directory structure which also matches the package structure expect by the <tt>plasmapkg</tt> command. More on this later. + This creates a simple directory structure which also matches the package structure expected by the <tt>plasmapkg</tt> command. More on this later.
    
  == Metadata.desktop ==   == Metadata.desktop ==

← Older revision		Revision as of 00:12, 24 June 2010
Line 131:		Line 131:
	Packages for openSUSE are available in the KDE:KDE4:Factory:Desktop repository (python-kdebase4 and python-devel).		Packages for openSUSE are available in the KDE:KDE4:Factory:Desktop repository (python-kdebase4 and python-devel).

−	Source files: http://websvn.kde.org/trunk/KDE/kdebase/workspace/plasma/scriptengines/python/	+	Source files: http://websvn.kde.org/trunk/KDE/kdebase/workspace/plasma/generic/scriptengines/python/

← Older revision		Revision as of 18:26, 7 August 2009
Line 114:		Line 114:

	== Troubleshooting ==		== Troubleshooting ==
		+
		+	'''Error: '''
		+	<code>Installation of hello-python.zip failed.</code>
		+	'''Solution:''' enable more verbose output from plasmapkg. Run kdebugdialog:
		+	<code>kdebugdialog --fullmode</code>
		+	and enable the outputs for ''1209 libplasma''.

	'''Error: '''		'''Error: '''