Comandos de Construcción y Desarrollo

(Build & Development Commands)

• Ejecutar un script: Usa python tu_script.py en tu terminal. Python es un lenguaje interpretado, ejecutas los archivos directamente.
• Instalar paquetes: Usa pip install nombre_paquete. pip es el instalador de paquetes estándar para Python.
• Crear un entorno virtual: Usa python -m venv .venv. Esto crea un entorno aislado para las dependencias del proyecto.

Guías de Pruebas

(Testing Guidelines)

• Escribe pruebas como funciones o métodos: Usa frameworks como unittest o pytest. Las pruebas se definen típicamente dentro de archivos de prueba dedicados.
• Usa assert para verificar condiciones: Se usa la instrucción assert incorporada de Python o métodos de aserción de los frameworks de prueba para verificar los resultados esperados.
• Ejecuta las pruebas: Usa comandos como pytest o python -m unittest discover.

Estilo y Guías de Código

(Code Style & Guidelines)

• Sigue PEP 8: Adhiérete a la guía oficial de estilo de Python para un formato consistente (por ejemplo, 4 espacios para indentación).
• Usa nombres descriptivos para variables y funciones: Elige nombres que indiquen claramente su propósito, a menudo usando snake_case.
• Prioriza la legibilidad: Escribe código que sea fácil de entender y mantener, aprovechando la sintaxis clara de Python.

Guías de Documentación

(Documentation Guidelines)

• Usa docstrings: Antes del docstring escribe la palabra "OlimpIA docs:". Escribe cadenas de texto entre comillas triples al inicio de módulos, clases y funciones para explicar qué hacen.
• Explica los parámetros y valores de retorno en los docstrings: Describe claramente las entradas y salidas de funciones y métodos.
• Mantén la documentación actualizada: Asegúrate de que los docstrings y cualquier documentación externa reflejen con precisión el código actual.