Documentación y pruebas en práctica

Principios de ingeniería de software en Python

Adam Spannbauer

Machine Learning Engineer at Eastman

Documentar proyectos con Sphinx

  Página de ejemplo de Sphinx

Principios de ingeniería de software en Python

Documentar clases

class Document:
    """Analizar datos de texto

    :param text: texto a analizar

    :ivar text: texto pasado originalmente a la instancia al crearla
    :ivar tokens: Lista de palabras analizadas del texto
    :ivar word_counts: Contador con el número de hashtags usados en el texto
    """
    def __init__(self, text):
        ...
Principios de ingeniería de software en Python

Pruebas de integración continua

    Logo de Travis CI

Salida de ejemplo de Travis - Fallo

Principios de ingeniería de software en Python

Pruebas de integración continua

  Salida de ejemplo de Travis - Éxito

Principios de ingeniería de software en Python

Enlaces y herramientas adicionales

  • Sphinx - Genera documentación atractiva
  • Travis CI - Prueba tu código continuamente
  • GitHub & GitLab - Aloja tus proyectos con git
  • Codecov - Descubre dónde mejorar las pruebas de tus proyectos
  • Code Climate - Analiza tu código para mejorar su legibilidad
Principios de ingeniería de software en Python

¡Vamos a practicar!

Principios de ingeniería de software en Python

Preparing Video For Download...