Feat: Se crea documentación de ejercicios practicos desde basico hasta avanzado

Author: jacs4210

.gitignore

@@ -100,6 +100,7 @@ celerybeat.pid
 .venv
 env/
 venv/
+envdev/
 ENV/
 env.bak/
 venv.bak/

CHANGELOG.md

@@ -17,6 +17,12 @@ y este proyecto adhiere a [Semantic Versioning](https://semver.org/spec/v2.0.0.h
 ### Fixed
 - N/A
 
+## [1.5.0] - 2025-08-01
+
+### Added
+- Documentación completa en español para todas los ejercicios desde basico, intermedio y avanzado.
+- Docstrings detallados con objetivos y conceptos clave.
+
 ## [1.4.0] - 2025-07-24
 
 ### Added

ejercicios/avanzados/14_largest_number_list.py

@@ -1,7 +1,19 @@
-numbers = [15, 2, 1, 3, 20]
-largest = numbers[0]
+"""
+Lección básica: Número más grande en una lista.
+Objetivo:
+    Recorrer una lista y encontrar el número más grande sin usar funciones integradas.
+"""
 
-for number in numbers:
-    if number > largest:
-        largest = number
-print(largest)
+def main():
+    """Encuentra e imprime el número más grande en una lista."""
+    numbers = [15, 2, 1, 3, 20]
+    largest = numbers[0]
+
+    for number in numbers:
+        if number > largest:
+            largest = number
+
+    print(f"El número más grande es: {largest}")
+
+if __name__ == "__main__":
+    main()

ejercicios/avanzados/15_remove_duplicates.py

@@ -1,9 +1,20 @@
-numbers = [1, 2, 3, 3, 4, 5, 5, 6]
-numbers_no_duplicates = []
+"""
+Lección básica: Quitar duplicados.
+Objetivo:
+    Eliminar valores repetidos de una lista sin usar estructuras complejas.
+"""
 
-for number in numbers:
-    if number not in numbers_no_duplicates:
-        numbers_no_duplicates.append(number)
+def main():
+    """Remueve duplicados de una lista y muestra el resultado."""
+    numbers = [1, 2, 3, 3, 4, 5, 5, 6]
+    numbers_no_duplicates = []
 
-print("Lista original:", numbers)
-print("Lista sin duplicados:", numbers_no_duplicates)
+    for num in numbers:
+        if num not in numbers_no_duplicates:
+            numbers_no_duplicates.append(num)
+
+    print(f"Lista original: {numbers}")
+    print(f"Sin duplicados: {numbers_no_duplicates}")
+
+if __name__ == "__main__":
+    main()

ejercicios/avanzados/16_number_in_letters.py

@@ -1,19 +1,33 @@
-numbers = {
-    "0": "Cero",
-    "1": "Uno",
-    "2": "Dos",
-    "3": "Tres",
-    "4": "Cuatro",
-    "5": "Cinco",
-    "6": "Seis",
-    "7": "Siete",
-    "8": "Ocho",
-    "9": "Nueve"
-}
-phone_in_letters = ""
-phone = input("Telefono: ")
+"""
+Lección básica: Número a letras (teléfono).
+Objetivo:
+    Tomar un número de teléfono y convertir cada dígito a su representación en palabras.
+"""
 
-for digit in phone:
-    phone_in_letters += numbers[digit] + " "
+def main():
+    """Convierte cada dígito ingresado en su palabra correspondiente."""
+    numbers = {
+        "0": "Cero",
+        "1": "Uno",
+        "2": "Dos",
+        "3": "Tres",
+        "4": "Cuatro",
+        "5": "Cinco",
+        "6": "Seis",
+        "7": "Siete",
+        "8": "Ocho",
+        "9": "Nueve"
+    }
+    phone_in_letters = ""
+    phone = input("Teléfono: ").strip()
 
-print(phone_in_letters)
+    for digit in phone:
+        if digit in numbers:
+            phone_in_letters += numbers[digit] + " "
+        else:
+            phone_in_letters += "?" + " "  # carácter no reconocido
+
+    print(f"Teléfono en palabras: {phone_in_letters.strip()}")
+
+if __name__ == "__main__":
+    main()

ejercicios/avanzados/17_emoji_converter.py

@@ -1,21 +1,32 @@
+"""
+Lección básica: Conversor de emojis.
+Objetivo:
+    Reemplazar atajos como ':)' por su emoji correspondiente en un mensaje.
+"""
+
 def emoji_converter(message):
+    """Reemplaza secuencias por emojis en una cadena."""
     emojis = {
         ":)": "😊",
         ":(": "😢",
         ":D": "😄",
         ":P": "😛",
         ";)": "😉"
     }
-    
+
     words = message.split(" ")
     converted_message = ""
-    
+
     for word in words:
         converted_message += emojis.get(word, word) + " "
-    
+
     return converted_message.strip()
 
-# Inicio del programa
-message = input(">")
-output = emoji_converter(message)
-print(output)
+def main():
+    """Lee un mensaje del usuario y lo convierte usando emojis."""
+    message = input("> ").strip()
+    output = emoji_converter(message)
+    print(output)
+
+if __name__ == "__main__":
+    main()

ejercicios/avanzados/19_get_max_number.py

@@ -1,8 +1,40 @@
+"""
+Ejercicio 19: Obtener el valor máximo de una lista
+
+Descripción:
+Este ejercicio consiste en encontrar el valor máximo de una lista de números 
+utilizando una función auxiliar definida en un módulo aparte (utils.py).
+
+Objetivos:
+- Practicar la importación y uso de módulos propios
+- Implementar una función para encontrar el valor máximo en una lista
+- Comprender la reutilización de código
+
+Recursos Adicionales:
+- Documentación oficial:
+  https://docs.python.org/3/tutorial/modules.html
+- Funciones útiles:
+  https://realpython.com/python-functions/
+
+Autor: Jairo Cuartas
+Fecha: 2025-07-26
+"""
+
 import utils
-# from utils import get_max # Importa solo la funcion get_max
 
+# from utils import get_max  # Importa solo la función get_max
+
+# Lista de números de ejemplo
 numbers = [1, 2, 3, 4, 5]
-max_number = utils.get_max(numbers)
 
+# Llama a la función get_max del módulo utils para obtener el valor máximo
+encontrado = utils.get_max(numbers)
+
+print(f"El valor máximo es: {encontrado}")  # Salida esperada: El valor máximo es: 5
 
-print(f"El valor maximo es: {max_number}")
+# =============================================================================
+# EJERCICIOS ADICIONALES
+# =============================================================================
+# 1. Modifica la lista para probar con otros valores y verifica el resultado
+# 2. Usa la función get_max con una lista de números negativos
+# 3. Implementa una función similar que devuelva el valor mínimo

ejercicios/avanzados/20_generate_random_values.py

@@ -1,11 +1,46 @@
+"""
+Ejercicio 20: Generar valores aleatorios con una clase Dado
+
+Descripción:
+Este ejercicio consiste en crear una clase Dice que simula el lanzamiento de dos dados, generando valores aleatorios entre 1 y 10.
+
+Objetivos:
+- Practicar la definición de clases y métodos
+- Usar la biblioteca random para generar números aleatorios
+- Comprender el retorno de tuplas desde métodos
+
+Recursos Adicionales:
+- Documentación oficial:
+  https://docs.python.org/3/library/random.html
+- Tutorial de clases:
+  https://realpython.com/python3-object-oriented-programming/
+
+Autor: Jairo Cuartas
+Fecha: 2025-07-26
+"""
+
 import random
 
 class Dice:
     def roll(self):
+        """
+        Simula el lanzamiento de dos dados y retorna una tupla con los resultados.
+        Returns:
+            tuple: (valor_dado_1, valor_dado_2)
+        """
         first_value = random.randint(1, 10)
         second_value = random.randint(1, 10)
-
         return (first_value, second_value)
 
+# Crear una instancia de la clase Dice
 dice = Dice()
-print(dice.roll())
+
+# Lanzar los dados y mostrar el resultado
+print(dice.roll())  # Salida esperada: (valor entre 1 y 10, valor entre 1 y 10)
+
+# =============================================================================
+# EJERCICIOS ADICIONALES
+# =============================================================================
+# 1. Modifica la clase para lanzar un dado de 6 caras
+# 2. Lanza los dados 5 veces y muestra todos los resultados
+# 3. Calcula la suma de los valores obtenidos en cada lanzamiento

ejercicios/avanzados/utils.py

@@ -1,6 +1,38 @@
+"""
+Módulo utils.py - Funciones auxiliares para ejercicios avanzados
+
+Descripción:
+Este módulo contiene funciones auxiliares para ejercicios de listas y números.
+Incluye la función get_max para obtener el valor máximo de una lista de números.
+
+Objetivos:
+- Practicar la definición de funciones en módulos
+- Reutilizar funciones en diferentes ejercicios
+
+Recursos Adicionales:
+- Documentación oficial:
+  https://docs.python.org/3/tutorial/modules.html
+- Funciones útiles:
+  https://realpython.com/python-functions/
+
+Autor: Jairo Cuartas
+Fecha: 2025-07-26
+"""
+
 def get_max(numbers):
+    """
+    Devuelve el valor máximo de una lista de números.
+    Args:
+        numbers (list): Lista de números
+    Returns:
+        int or float: Valor máximo encontrado
+    """
     max_number = numbers[0]
     for number in numbers:
         if number > max_number:
             max_number = number
-    return max_number
+    return max_number
+
+# Ejemplo de uso:
+# lista = [10, 5, 8, 20]
+# print(get_max(lista))  # Salida esperada: 20

ejercicios/basicos/01_hospital_app.py

@@ -1,8 +1,19 @@
-# Nombre del paciente
-patient_name = "John smith"
+"""
+Lección básica: Datos de paciente.
+Objetivo:
+    Mostrar nombre, edad y si es nuevo o existente en un resumen simple.
+"""
 
-# Edad del paciente
-age = 20
+def main():
+    """Define los datos del paciente y muestra el resumen."""
+    patient_name = "John Smith"
+    age = 20
+    is_new_patient = True
 
-# Indica si el paciente es nuevo o existente
-is_new_patient = True
+    estado = "Nuevo paciente" if is_new_patient else "Paciente existente"
+    print(f"Paciente: {patient_name}")
+    print(f"Edad: {age}")
+    print(f"Estado: {estado}")
+
+if __name__ == "__main__":
+    main()