Finally, after a few days of difficult work, it’s here: the prototype for kdev-python’s new GHNS support for documentation data!
| kdev-python now has its own settings module providing GHNS support |
Technology
I don’t want to go into detail here (I’m a bit sick of this stuff currently *grin*), but the OCS backend is written by me and running on my own server currently, for testing purposes. It’s python2 / django using MySQL as database backend, and nginx for a web server. You can register a new user acoount here (admire the awesomeness of stylesheet-free default template files!). The backend is extremely incomplete and doesn’t support most operations. Basically, you can upload an item with a title and a description, and download it again. No screenshots, no license types, no ratings, no download counter. Oh, but the search works. 😉
The upload dialog requires current kdelibs 4.10 (stable doesn’t work) because of a bug I fixed there which prevented changing the provider to something other than the default opendesktop.org one.
There’s also a patch of mine pending review for libattica to fix a bug causing annoying spoof-checker warnings to be displayed when connecting.
The feature is currently residing in the “ghns” branch of kdev-python, so if you want to try it, you’ll have to compile that branch.
Use cases and tools provided
In addition to GHNS integration, I also implemented a set of tools for “develpoing” documentation data. In the following, I will describe them and their purpose. This, once more, is the KCM (you can access it via KDevelop » Configure KDevelop » Python Documentation Files):
| The new KCM, once again |
The “Download new” tool
This one is pretty obvious: you can download documentation files created by other users. You are presented with a list of content and you can install and uninstall the individual packages with one click each.
The “Share selected” tool
The widget allows you to select any amount of files or directories to put into an entity you consider useful to share in the widget on the left, and upload them. A tar.gz archive will automatically be created from the selected files, all you have to do is enter your user name and a title for your package and click upload.
If you select no files, you can chose a tar archive you created yourself.
Packages should be for one Python module specifically. Please don’t make packages which are like “CoolNick47â„¢’s perfect collection of kdev-python docfiles”, but keep them very specific, e.g. “Documentation for numpy.fft” or “django 1.5 fixes”.
The “Generate” tool
This tool starts a little wizard which helps in bootstrapping docfiles for totally undocumented modules, such as those written in C.
![]() |
| The …read more Source: FULL ARTICLE at Planet KDE |


