Documentation

[Lonami]

Since this project is aimed at educational purposes, it's really important to have everything documented. A new comer (like me) will need to invest a considerable amount of time only to get used to the project structure if they were to join the team and work being aware of everything.

There should be at least a more detailed description in the README.md detailing what this project is for and what it's aimed at. Ideally, a Project Structure section that details what every folder and subfolder/module does. The names used may not be obvious at first glance.

Of course, every file and method should have a docstring to know what it does, and what types it accepts for the parameters. Although it's possible to use natural language, in the future, one may want to use http://readthedocs.org/ to host the documentation, and Sphinx or similar to build it (which in turn uses these docstrings automatically).

Ideally, the __init__.py inside each module should also have a description on what it is for.