Coding Guidelines

In a small form factor

• the code (variable names, etc) and comments are in English only.
• conventional namings : follow our pylint configuration in the QA Tools.
• in your editor, use TABS only for indentation. NO spaces, NO mixing.
• use UTF-8 for every file (code, data, configuration, whatever).
  • put the docstring first in headers (# -*- coding: utf-8 -*-)
• hard limit of right margin @80 chars, except where convoluted variable assignation can't be shortened (very long table[table[var.attr.attr]]), but then there may be another problem ;-)
• put yourself in the copyright notice of every file you modify more than 10 lines (NOT every file !)
• try to follow  PEP-8 when meeting a question not answered here.

Further reading

Please read the QA Tools page, to learn how to configure and use them.