Temario Lección 242 de 250 · Proyecto final: publícalo (empaqueta tu proyecto)
Proyecto final: publícalo (empaqueta tu proyecto)

README + ejecución con un solo comando

Tienes una estructura limpia y pruebas reales. El último tramo es la parte con la que de verdad se topan primero quienes revisan: el README y el único comando que pone la cosa en marcha. Un proyecto que necesita diez minutos de adivinanzas para arrancar parece roto aunque funcione. Un proyecto que puedes clonar y ejecutar con una sola línea parece profesional aunque sea pequeño. El mismo código -> una impresión radicalmente distinta.

El README es un contrato. Quien lo lee lo hojea de arriba abajo, y espera una forma predecible: el nombre del proyecto como título, luego cómo instalarlo, luego cómo usarlo, luego cómo probarlo. En concreto, un buen README tiene una línea de título de nivel superior (# Something) y luego estas secciones en este orden:

# Triage Copilot

## Setup
pip install -e .            # editable install
cp .env.example .env        # then paste your real key into .env

## Usage
python -m triage            # the one-command run

## Tests
pytest

El orden importa porque quien lee lo sigue como pasos. Usage antes que Setup confunde -> no puedes usar lo que no has instalado. Así que escribes un comprobador, validate_readme(text), que devuelva True solo si aparece un título # , seguido de ## Setup, luego ## Usage y luego ## Tests, cada uno después del anterior. Una sección que falta, o secciones desordenadas, devuelve False. El truco: recorre las líneas una vez, lleva un "cursor" de dónde estás y exige que cada sección aparezca en una posición posterior al cursor.

La ejecución con un solo comando. Fíjate en que la línea de ## Usage de arriba es un único comando. Ese es el objetivo de un objetivo de Makefile o justfile como make run -> un comando fácil de recordar que lanza el proyecto, para que nadie tenga que recordar la invocación completa. Escribe make_run(name), que devuelva esa cadena de comando para un proyecto, por ejemplo python -m triage (o make run). Debe incluir el nombre del proyecto, normalizado igual que el directorio del paquete, para que un proyecto distinto dé un comando distinto.

Dos notas honestas, no evaluadas, para el repositorio real. Primero, los secretos: el paso cp .env.example .env existe porque tu clave de API real va en .env, que añades a .gitignore y nunca subes al repositorio. Solo subes .env.example -> la forma de la configuración con valores de relleno. Filtrar una clave a un repositorio público es el error clásico de los proyectos de portafolio. Segundo, desplegarlo: para ponerlo en línea escribirías un pequeño Dockerfile (copiar el repositorio, pip install, poner el comando de ejecución como punto de entrada) y lo subirías a una PaaS como Render, Railway o Fly. Esa parte no se puede ejecutar ni evaluar en tu navegador -> te toca a ti cuando lo publiques. Pulsa Ejecutar para validar un README completo e imprimir el comando de ejecución.

Tu turno

Escribe las dos piezas deterministas de un buen README. validate_readme(text) devuelve True si y solo si aparece un título de nivel superior # , luego ## Setup, luego ## Usage y luego ## Tests, cada uno después del anterior (una sección que falta o secciones desordenadas -> False). make_run(name) devuelve la cadena de ejecución con un solo comando (por ejemplo python -m <pkg> o make run) que incluye el nombre del proyecto, normalizado como el directorio del paquete, para que un nombre distinto dé un comando distinto.

¿Has visto un problema en esta lección? Avísanos · Preguntar sobre esta lección

Este ejercicio se abre pronto

Termina la lección anterior y esta se desbloquea. Todo el curso es gratis, no hace falta cuenta, y puedes leer esta lección ahora mismo.