Infos for writing/releasing own screenlets - FAQ

[RYX]

Hi everyone!

Here are some infos/tips for people who want to write their own screenlets. I only sum up a few points here now, I'll add some more details later.

Writing own screenlets:
- check the sources of the default screenlets to see how things work
- please read and obey the coding rules in the README (as far as possible, I know keeping 80 chars is sometimes a pain)
- generate API-documentation using "make docs" or "make epydoc" (install python-epydoc first) ,the api is also stored here https://code.launchpad.net/screenlets/trunk/
- you may want to install devhelp and the devhelp-documentation for pygtk, it is a very good reference
- please use SVG-images wherever possible to ensure scalability
- add an icon.svg to your screenlet (to make it look good in manager)
- only write as many screenlets as you can maintain and care for
- think about contributing enhancements to the framework instead of reproducing big amounts of code within your screenlet

Packaging a screenlet:
- use the screenlets-packager tool to package your screenlet for release (e.g.):screenlets-packager ~/.screenlets/Weather

Finding a host for your package
One suggestion ,post your screenlet on www.gnome-look.org under the screenlet section , gnome-look provides you to upload your content there , so it will remain in their servers forever , and your screenlet will be safe and backed up, then you can post it on www.screenlets.org and provide the download link from gnome-look


FAQ - Now that the screenlets website is complete, you can find all screenlets-related information and downloads on http://screenlets.org.

[whise]

One suggestion ,post your screenlet on www.gnome-look.org under the desklet section , gnome-look provides you to upload your content there , so it will remain in their servers forever , and your screenlet will be safe and backed up, then you can post it on Screenlets.org and provide the download link from gnome-look

[jsf]

Tip for anyone attempting to create a home page for a screenlet on screenlets.org - you'll want to use the "Upload File" link at the bottom of the page in screenlets.org to upload your screenlet's image. Take note of the name the file is given at the end of uploading (<filename>) and then put the image into your new screenlet's home page using the following syntax (showing syntax for embedding download link as well):

|image=[[Image:<filename>]]
|download=[<downloadURL>]

[jsf]

I'd like to extend sensor.py to cover other system information like RAM, battery, network, disk, etc. How would I submit changes/extensions to this?

Also, I wonder if anyone had had any particular plans about directions to take in this part of the framework. I don't want to take the code off whatever path the originators have in mind.

[vadi]

Try checking out screenlets on launchpad.net, RYX put the development up there - maybe the project plans are there also.

[jsf]

Yeah. I'd seen that before and didn't find anything about directions for the sensor.py stuff. Thanks for the tip, though. I'll keep checking on that site as well as this one for anything regarding getting involved in the framework development.

[RYX]

The new sensors module in the current development-trunk already contains most of what you mention. If you have more ideas on how to extend the module, please let me know.

See here for the changes:
http://codebrowse.launchpad.net/~screenlets-dev/screenlets/trunk/revision/46

:)