Skip navigation.
KDE Developer's Journals

KDE API docs for us Pythonists

simon edwards's picture

After the kdebindings meeting about a month ago in Berlin, I had a 8-ish hour long trip back on the train from Berlin to Nijmegen. Deutsche Bahn's trains are rather civilised and have power on board for all your laptop charging needs (provided you can get close enough to the seats with the tables *and* the power outlets). Anyway, after getting some preliminary Python coding working inside KDE 4's systemsettings (thanks go to rdale for his help), I had a go at trying to fix up the PyKDE class documentation to more closely match the C++ KDE API docs. About 5 weeks of hack time later I now have something which is ready enough for the public. The formatting is much more in line with the C++ docs and the pages are laid out and cross linked much better than the previous class reference for PyKDE. It is still not perfect (code fragments are not translated to Python), but it should be perfectly usable 98% of the time. Give it a try.

This is part of my effort to update the PyKDE docs a bit move them over to the KDE techbase where it is much easier for everyone to help keep them updated and to add more information.

Oh, and I can't forget the obligatory:

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.
yuriy's picture

Thanks, this is awesome!

Much better! And it's at api.kde.org where one one expect to find it.

One thing: I think it's most important for this documentation to document where the API differs from the C++ API. For example, the use of exec_ and global_. For example, see the KIconLoader documentation which inaccurately says there is a global() method, which in reality gives a syntax error in python.

jriddell's picture

Genius

You are a genius.

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.