README.hacking¶

Library documentation¶

Python debian:

/usr/share/doc/python-debian/examples
Python git:

http://gitpython.readthedocs.io/en/stable/tutorial.html
Launchpad API:

https://help.launchpad.net/API/launchpadlib
Graphviz DOT language:

https://en.wikipedia.org/wiki/DOT_(graph_description_language)
PyGraphviz library:

http://pygraphviz.github.io/documentation/pygraphviz-1.4rc1/tutorial.html

http://pygraphviz.github.io/documentation/pygraphviz-1.4rc1/reference/agraph.html
Jinja template engine (used to generate HTML pages by the Iron Hand):

http://jinja.pocoo.org/docs/2.9/

http://jinja.pocoo.org/docs/2.9/templates/
Sphinx (used to build this documentation whose source code lives in doc/):

http://www.sphinx-doc.org

Coding guidelines¶

Use Python 3 instead of Python 2.
File licenses are usually GPLv2 or later.
Default configuration is located in conf/defaultrc.
Package metadata which needs to be updated constantly on new upstream releases is located in https://code.launchpad.net/~kubuntu-packagers/ka/+git/ka-metadata

Some of these kind of files need to be updated manually, others are automatically generated with ka-update-metadata.

The JSON files stored there may have comments starting with //. Usually there is a comment on top of each one saying if the file was generated automatically.

Please use this kind header for python source code files; note that it includes kate and vim modelines:

#!/usr/bin/python3
# -*- coding: utf-8 -*-
# pylint: disable=line-too-long
# kate: space-indent on; indent-width 4; replace-tabs on; indent-mode python; remove-trailing-space modified;
# vim: expandtab ts=4
# pylint: enable=line-too-long

############################################################################
#   Copyright © YEAR Copyright Holder Name <copyright_holder@mail.com>     #
#                                                                          #
#   This program is free software; you can redistribute it and/or modify   #
#   it under the terms of the GNU General Public License as published by   #
#   the Free Software Foundation; either version 2 of the License, or      #
#   (at your option) any later version.                                    #
############################################################################

Commands or variables using a release type string must use these values: "frameworks", "plasma", "applications", "qt"

You may also use “other” if that’s appropiate.