codember

Resolución de los retos del juego codember creado por @midudev para la comunidad.

Tabla de contenidos

• codember
  • Tabla de contenidos
  • Tabla de retos
  • ¿Pensabas que solo tenia esto?
    • Uso
      • Requisitos
      • Arrancar
      • Desarrollar soluciones a los retos
      • Desarrollar nuevos endpoints
      • Detalles técnicos
        • Urls
    • Contribuir
      • ✅ Cambios que se aceptaran
      • ❌ Cambios que no se aceptaran
    • Notas

Tabla de retos

Challenge	Solución
#01	Python
#02	Python
#03	Python
#04	Python
#05	Python

---

¿Pensabas que solo tenia esto?

Para hacer algo especial con este repositorio implemente lo siguiente:

• Una interfaz web hecha con Nuxt3 para ver los resultados, los nombres de los reto, los tiempos de ejecución, el código fuente, la url del archivo con los datos de entrada y las trazas de error, si se produce una excepción, de las soluciones. Ademas permite volver a ejecutar las soluciones con tan solo pulsar un botón.

• Una Api hecha con Flask que ejecuta las soluciones a los retos y obtiene los resultados, los nombres de los reto, los tiempos de ejecución, el código fuente, la url del archivo con los datos de entrada y las trazas de error, si se produce una excepción, de las soluciones. Pero, ¿Como puedes ejecutar las nuevas soluciones bajo demanda sin tener un tener un registro de ellas? Con importlib de Python, utilizándolo para importar dinámicamente el modulo que contiene la función que soluciona el reto. Ademas cada vez que se obtiene el modulo se hace un reload de el con importlib para invalidar la versión cacheada.

• Swagger UI para que puedas testear los endpoints y tengas sus especificaciones.

• Docker, es decir, con un simple comando puedes levantar todo el sistema. Pero y si cambio la solución, ¿Tengo que levantar otra vez el sistema? Pues no, el docker-compose ya esta preparado para que puedas desarrollar tranquilamente en local y cada vez que guardes tu solución, al recargar la interfaz web, se recarguen los datos. ¿Pero como? Pues gracias a los Bind mounts de Docker. Gracias a estos, puedo devolver los retos que hay en el momento en que recibe la petición la Api.

Uso

Requisitos

• Tener instalado Docker Engine. Instalar.

Arrancar

• Ejecutar:

  docker compose up --build

• Abrir la URL http://localhost:3000.

Desarrollar soluciones a los retos

Para crear una solución apara un reto debemos crear una carpeta con el nombre del reto en la carpeta api dentro de la carpeta src.

Dentro de la carpeta con el nombre del reto debemos crear un archivo main.py. Dentro de este debemos crear una variable en la raíz del script con la url del archivo con los datos de entrada llamada input_url. También dentro de el debemos crear una función con el nombre solution que deberá devolver la solución del reto. Esta función deberá recibir un parámetro llamado input. Este parámetro contendrá los datos de entrada devueltos por la url definida en el mismo archivo en la variable llamada input_url. Dentro de la carpeta con el nombre del reto debemos crear como mínimo este archivo pero podemos crear cualquier otro archivo que queramos.

Desarrollar nuevos endpoints

Siente te libre de añadir los nuevos endpoints que quieras para mejorar el proyecto. Si quieres que esto se refleje en el Swagger UI, actualiza el objeto que devuelve el endpoint swagger.

Detalles técnicos

Urls

• Api: http://localhost:5000
• Web: http://localhost:3000
• Swagger UI: http://localhost:5000/api/v[version]/docs

Contribuir

• Hacer fork del proyecto.
• Crear rama con el nombre del cambio.
• Hacer pull request con el cambio desde la rama que hemos creado a la rama main de este repositorio.

✅ Cambios que se aceptaran

• Mejoras en la UI
• Optimizaciones de código de la plataforma
• Nuevas soluciones (para ver como contribuir en este caso, crear una issue)

❌ Cambios que no se aceptaran

• Cambios en las soluciones de otras personas

Notas

Ideas cogidas para el README del repositorio https://github.com/jpaddeo/codember