Estándares de Desarrollo del Proyecto

Los estándares de desarrollo constituyen las normas, procedimientos o patrones de referencia que dan los detalles técnicos y las reglas necesarias que se deben implementar en el desarrollo de aplicaciones de software. Para el desarrollo de este proyecto utilizaremos como estilo de programación el PEP-8 ​http://www.python.org/dev/peps/pep-0008/. Algunos de los puntos más importantes de este estilo de programación son:

• Utilizar solo espacios en blanco (cuatro espacios) y no tabulaciones para la identación.
• Separar las funciones no anidadas y las definiciones de clases con dos líneas en blanco.
• Separar las definiciones de métodos dentro de una clase con una sola línea.
• Limitar todas las líneas a un máximo de 79 caracteres.
• El código en la distribución del núcleo de Python siempre deberá utilizar la codificación ASCII o Latín-1 (También conocida como ISO-8859-1), para Python 3.0 en adelante deberá usarse UTF-8. Los archivos que usan ASCII (o UTF-8, para Python 3.0 y superiores) no deberían tener una línea de especificación del juego de caracteres. Sólo debería usarse Latín-1 (o UTF-8) cuando en un comentario o cadena de documentación (docstring) se necesite mencionar un nombre de autor que requiere Latín-1; de no ser así, es preferible utilizar los caracteres de escape \x, \u o \U incluir datos no-ASCII en literales de cadenas.

Colocar los imports en la parte superior de los archivos, después de cualquier comentario o cadena de documentación del módulo, y deben ser colocado en líneas separadas. Organizar los imports por grupos, donde primero se deben colocar los imports de la librería estándar, luego los de proyectos de terceras partes relacionadas, y por último el grupo de imports de aplicaciones locales y específicos de la librería. Colocar una línea en blanco entre cada grupo.

• Actualizar siempre los comentarios cuando se modifique el código.
• Cada línea de un bloque de comentario comenzarla con un # y un espacio en blanco. La primera palabra debería estar en mayúsculas, a menos que sea un identificador que comience con una letra en minúsculas.
• Escribir cadenas de documentación (docstrings) para todos los módulos, funciones, clases, y métodos públicos. El PEP257 ​http://www.python.org/dev/peps/pep-0257/ describe las convenciones para la realización de cadenas de documentación.
• Utilizar nombres cortos y con todas las letras minúsculas para los nombres de los módulos, métodos y funciones. Se puede incluir el carácter de subrayado.
• Utilizar nombres cortos y con todas las letras minúsculas para los nombres de los paquetes. No incluir el carácter de subrayado.
• Utilizar para los nombres de las clases la convención CapWord?, cada nombre debe comenzar con una letra mayúscula.
• Utilizar para los nombres de las constantes todas las letras mayúsculas. Se debe incluir el carácter de subrayado para separar palabras.