[Shinken-devel] Code quality

[Aurelien D. <aur...@ce...>]

Hello

I want to give you some of my best advises I can for any Python development.
The most important element I discovered since I'm developing in Python are the following 3 tools.

  - unittest
  - coverage
  - pylint

This 3 tools used together can help a lot into increasing Python code quality and avoid bugs.

. unittest

Write unit tests, this is really important to test every piece of your code is working as expected and no regression are 
introduced.

. coverage

http://nedbatchelder.com/code/coverage/
http://pypi.python.org/pypi/coverage/

When you have unit tests, it is really interesting to use them with Coverage. This is a python tool that will compute 
the code coverage of those tests and tell you which line of your sources are not tested by them.
This is really the unittest best friend.

. pylint

Pylint si code checker developed by french team Logilab. It is checking a lot (a lot!) of things on your Python code. It 
can detect bugs without running the code. It checks the PEP8 conformity which is important IMHO for any Python 
collaboration. And a lot more. It is highly configurable, and I strongly advise any python developer to try to run it on 
its code.


Hoping this can help Shinken.


Aurelien