Pyjama's Plugin interface

Pyjama has a quite simple plugin interface which - so I think - will enable you to develop what ever you want as a plugin.

For now I am the developer of most of pyjama's plugins but I hope this will change soon. If you need another interface, a new event or another way to interact with pyjama, please just write a mail and ask for it!

The following section was taken from the plugin's readme file:

---

 A short guide to plugins for pyjama
+-----------------------------------+

 Pyjama uses a new plugin system since version 0.1.29.
 This is a short guide how to do plugins for pyjama now.

 Requirements
+------------+
    1) plugins have to be stored in pyjama's plugin folder
    2) every plugin has its own folder there
    3) each plugin needs a .info file in its folder
    4) each plugin needs a file called "__init__.py" in its folder

 .info file
+----------+
    1) this file has to have the same name as its folder
    2) it holds:

"name" to store the plugin's full name
"version" to store the plugin's current version
"order" to influence in which order the plugins are loaded
          the higher this value is the later pyjama will load the plugin
"author" to store the author's name
"description" for a short description of the plugin
"copyright" for a short copyright line
"license" the license of the plugin.
"homepage"

    A proper .info file might look like this:

    Name = Example Plugin 123
    Order = 500
    Version = 0.17
    Author = Me
    Description = Just testing
    Copyright = By me 2009-FFFFFF
    license = GPLv3
    homepage = http://www.xn--ngel-5qa.de

 __init__.py
+-----------+
    * this file is needed to treat the while directory as a module
    * it needs to have a class called "main"
    * pyjama will pass a object holding all pyjama objects to this class

 Example
+-------+
    the directory scheme should be something like this:

    pyjama/
        plugins/
            my_plugin/
                __init__.py
                my_plugin.info
            anotherplugin/
                __init__.py
                anotherplugin.info

!! Please have a look at pyjama's example plugin - it is quite simple !!

Preferences If you want to show preferences for your plugin, you should use pyjama's preferences dialog. This can be done in three simple steps:

• you need ne function that creates a container (i.e. gtk.VBox), puts some widgets on it and returns the container
• you need a second function that will be called by pyjama after the user has closed the preferences dialog pressing "Ok"
• tell pyjama about your preferences and call: self.pyjama.preferences.register_plugin("NAME", first_function, second_function)

As said before: Have a look at the example plugin!