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

Organiza el repositorio

En los proyectos finales anteriores construiste algo real: un copiloto de soporte, un extractor de documentos, una barrera de evaluación. Ahora mismo probablemente vive como un montón de celdas o un único script largo. Quien te contrate y lo abra tiene que adivinar dónde está cada cosa, y quien selecciona personal, si lo clona y no ve una forma obvia de ejecutarlo, simplemente cierra la pestaña. Lo que más rinde que puedes hacer por un proyecto de portafolio es darle una estructura aburrida y convencional para que cualquiera se oriente en 30 segundos.

Nota honesta desde el principio: este módulo trata del repositorio, no de un despliegue en vivo en la nube. No podemos levantar un servidor ni subir nada a un alojamiento desde tu navegador, y no vamos a fingirlo. Lo que sí puedes aprender y demostrar aquí es la estructura, las pruebas y la ejecución con un solo comando que hacen que un despliegue sea trivial más adelante. Las notas de despliegue del final son exactamente eso -> notas, marcadas como no evaluadas.

La estructura en la que acaban convergiendo casi todos los proyectos de Python:

my_project/
  README.md            # what it is + how to run it
  pyproject.toml       # name, version, dependencies
  .env.example         # the shape of the secrets (NEVER the real ones)
  src/
    my_project/        # the importable package
      __init__.py
      __main__.py      # runs on `python -m my_project`
      core.py          # your actual code
  tests/
    test_my_project.py # pytest finds these by the test_ prefix

Dos cosas en las que fijarse. Primero, el paquete vive bajo src/ en una carpeta con el nombre del proyecto -> eso es la "estructura src", y evita que tus pruebas importen por accidente la carpeta local en lugar del paquete instalado. Segundo, el nombre del directorio del paquete sigue al nombre del proyecto: un proyecto llamado triage tiene src/triage/, uno llamado copilot tiene src/copilot/. No hay una única respuesta fija -> el árbol es una función del nombre.

Tu trabajo es escribir esa función. build_manifest(name) recibe un nombre de proyecto y devuelve la lista de archivos que debería contener el repositorio, como una lista ordenada de cadenas de ruta. Debe incluir README.md, pyproject.toml, un directorio de paquete bajo src/<name>/ con __init__.py y un archivo de módulo, y un archivo tests/test_*.py. Normaliza el nombre en un directorio de paquete válido (minúsculas, y convierte los espacios y guiones en guiones bajos, porque doc-extractor no es un nombre de módulo importable pero doc_extractor sí).

Este es el manifiesto que crearía en disco un script de andamiaje. En el evaluador no escribimos archivos -> comprobamos que sabes describir el árbol correcto para cualquier nombre de proyecto. Pulsa Ejecutar para imprimir la estructura de un proyecto llamado triage.

Tu turno

Escribe build_manifest(name), que devuelva el árbol de archivos del repositorio de un proyecto como una lista ordenada de cadenas de ruta. Debe incluir README.md, pyproject.toml, el directorio del paquete bajo src/<pkg>/ con un __init__.py, un __main__.py (ese archivo es lo que hace funcionar python -m <pkg>, el comando de ejecución de la lección 3) y al menos otro archivo de módulo .py, y un archivo de pruebas llamado tests/test_<pkg>.py. Normaliza name en el directorio del paquete (minúsculas, los espacios y guiones pasan a ser guiones bajos) para que un nombre de proyecto distinto produzca un árbol 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.