Configuración inicial del proyecto Platy News con Python

Clase 2 de 17Curso de Python Profesional: Arquitectura de Proyectos, Entornos y PyPI

Resumen

Domina un flujo real de desarrollo en Python con Platy News, una aplicación de línea de comandos capaz de buscar noticias con APIs y procesarlas con IA. Aprenderás a clonar el repositorio de GitHub, crear entornos virtuales, instalar en modo editable, configurar API keys en .env y ejecutar el comando platynews para obtener resultados con un LLM. Ideal para practicar programación orientada a objetos, typing en Python 3.13, unit testing y conceptos de rendimiento en código legacy.

¿Qué es Platy News y qué lograrás con Python?

Platy News es una CLI que integra varias fuentes de información para buscar noticias y complementarlas con análisis de IA. Reúne conocimientos desde variables y ciclos hasta entornos virtuales, POO, typing y AsyncIO, guiándote hacia un trabajo más profesional y colaborativo.

  • Aplicación de línea de comandos con comandos intuitivos en la terminal.
  • Búsqueda de noticias con múltiples fuentes: News API, The Guardian y OpenAI.
  • Análisis con IA integrado mediante un LLM.
  • Python 3.13 como requisito por el uso de typing avanzado.
  • Trabajo en equipo y mejora de un código legacy.
  • Pruebas unitarias con carpeta test para validar el proyecto.

¿Cómo clonar e instalar el proyecto paso a paso?

El proyecto se distribuye en un repositorio con readme que irás mejorando. La estructura incluye paquetes, módulos y la carpeta test con pruebas unitarias. Usarás Visual Studio Code para explorar el código y la terminal para ejecutar comandos.

¿Qué estructura tiene el repositorio y qué herramientas usarás?

  • README inicial que documenta requisitos y uso.
  • Paquetes y módulos organizados por funcionalidad.
  • test con pruebas unitarias para validar el comportamiento.
  • Visual Studio Code para editar y ejecutar.
  • Terminal para comandos del flujo de instalación.

¿Qué comandos ejecutar en la terminal?

  • Clonación con git clone usando el enlace SSH y apertura en VS Code.
git clone <URL-SSH>
cd <carpeta-del-repositorio>
code -r .
  • Creación del entorno virtual con el comando indicado y activación según tu sistema.
vvm
# luego activar con el comando que muestre vvm.
  • Instalación en modo editable para habilitar el comando platynews.
vpip install -e
  • Verificación rápida del comando (mostrará errores si faltan claves).
platynews

¿Cómo configurar API keys y ejecutar comandos con IA?

La configuración se hace con un archivo .env en la raíz del proyecto. Debes crear el archivo y pegar las API keys siguiendo el readme. Sin estas claves, platynews mostrará errores al iniciar.

¿Dónde crear y pegar las API keys en .env?

  • Crea el archivo .env según lo indicado en el readme.
  • Genera y copia la clave de News API desde tu cuenta y pégala en .env.
  • En OpenAI crea una nueva clave secreta y verifica que tienes saldo activo.
  • Regístrate en The Guardian como desarrollador, confirma el correo y copia la clave recibida a .env.
  • Guarda el archivo y vuelve a ejecutar platynews.

¿Cómo probar una consulta con guardian y LLM?

  • Abre el readme y toma un ejemplo de uso con un tema como “cambio climático”.
  • Ejecuta el comando para preguntar por las “principales causas” usando el source guardian.
  • Espera unos segundos para ver la lista de temas procesados por el LLM.
  • Si aparece la ayuda de uso en vez de errores, las API keys están bien configuradas.

  • Buenas prácticas:

  • Verifica el entorno virtual activo antes de instalar o ejecutar.
  • Mantén el readme actualizado con cada cambio.
  • Revisa la carpeta test para entender los unit tests del proyecto.

¿Listo para avanzar? Comenta si ya ejecutaste tu primera búsqueda y si el análisis de IA respondió lo que esperabas.