actirepo

Aplicación Python que organiza un repositorio con preguntas de Moodle en formato XML.

¿Cómo funciona?

Busca las carpetas que contengan el fichero activity.json y la considera una actividad. Luego, a partir de los metadatos del fichero activity.json y el fichero de preguntas en formato Moodle XML (questions), genera un fichero README.md con la descripción de la actividad, un enlace de descarga a los ficheros de preguntas XML y 1 captura de pantalla por cada tipo de pregunta.

Las capturas de pantalla se guardan en el directorio images.

Ejemplo de activity.json:

{
    "name": "El microprocesador",
    "description": "Preguntas tipo test, de asociación y de respuesta corta sobre el microprocesador",
    "difficulty": "hard",
    "author": {
        "name": "Francisco Vargas Ruiz",
        "email": "fvarrui@canariaseducacion.es"
    },
    "questions": [ "questions.xml" ]
}

¿Cómo lo uso?

Instalar el paquete actirepo

pip install actirepo

Caution

Aún no se ha publicado en PyPI.

Mostrar la ayuda

$ actirepo --help
Uso: actirepo (-h | -v | -l [RUTA] | -i FICHERO | -R RUTA | -C [RUTA] | -c [RUTA]) [-r] [-f] [-H]

Organizador de actividades

Comandos:
  -h, --help            Muestra esta ayuda y termina
  -v, --version         Mostrar versión
  -l [RUTA], --list [RUTA]
                        Listar actividades de forma recursiva en el directorio especificado (o directorio actual si no se proporciona)
  -i FICHERO, --images FICHERO
                        Genera imágenes de las preguntas de una actividad
  -R RUTA, --readme RUTA
                        Crear README.md para repositorio y/o actividad en el directorio especificado. Se puede combinar con "-r".
  -C [RUTA], --create-activity [RUTA]
                        Crear los metadatos de la actividad en el directorio especificado (o directorio actual si no se proporciona)
  -c [RUTA], --create-repo [RUTA]
                        Crear los metadatos del repositorio en el directorio especificado (o directorio actual si no se proporciona)

Opciones:
  -r, --recursive       Buscar actividades recursivamente en subdirectorios. Se puede combinar con --readme y --create
  -f, --force           Forzar la creación de README.md aunque no sea necesario
  -H, --html            Genera también el HTML de las preguntas al generar las imágenes

¡Espero que te sea útil!

Listar las actividades del repositorio

Muestra un listado de todas las actividades disponibles en el repositorio, incluyendo estadísticas del número de preguntas por tipo.

Generar el README de la actividad

Ejecuta el siguiente comando para generar el fichero README.md en el directorio indicado:

actirepo [--recursive] --readme RUTA

Si se especifica la opción --recursive, la búsqueda de actividades será recursiva a partir de la RUTA indicada, por lo que si se indica el directorio raíz del repo, se generarán los ficheros README de todas las actividades.

Si el fichero README existe y es anterior a los cambios realizados en la actividad (metadatos o ficheros de preguntas XML), se volverán a generar el README y las imágenes. En caso contrario, no se harán cambios.

Es necesario incluir la opción -X utf8 en Windows debido a problemas en la codificación.

Crear los metadatos

Es posible generar un fichero de metadatos activity.json para las actividades, que luego sólo será necesario rellenar:

actirepo [--recursive] -c [RUTA] 

Si no se especifica la RUTA, el fichero se genera en el directorio actual.

Si se especifica la opción --recursive, la aplicación buscará ficheros XML de forma recursiva a partir de la RUTA , considerándolos ficheros de preguntas, y generará en el mismo directorio el fichero activity.json en caso de que no exista.

Ejemplo

Suponiendo que el directorio de la actividad se llame cableado y que exista el fichero de preguntas preguntas-cableado.xml, el fichero activity.json generado sería:

{
    "name": "Cableado",
    "description": "<descripción de la actividad>",
    "difficulty": "easy|medium|hard",
    "author": {
        "name": "<tu nombre>",
        "email": "<tu email>"
    },
    "questions": [ "preguntas-cableado.xml" ]
}

Tip

questions es opcional; si no lo indicamos buscará automáticamente todos los ficheros XML de preguntas del directorio.

Información relacionada

Plantillas

Las plantillas utilizadas para generar los ficheros README y los HTML de las preguntas (para luego renderizarlas en PNG) se encuentran en el directorio src/actirepo/templates.

Vista previa de las preguntas en HTML

El código HTML de la vista previa de las preguntas, utilizado para crear las plantillas, se extrajo de Moodle utilizando PageRip, una extensión de Google Chrome que permite extraer fragmentos de páginas HTML incluyendo el CSS en línea.

Para desarrolladores

Clonar el repositorio y entrar en el directorio:

git clone https://github.com/teuton-software/actirepo
cd actirepo

Crear un entorno virtual:

python -m venv venv

Instalar el paquete en modo de edición, de modo que se crearán los scripts del paquete y se instalarán las dependencias en el entorno virtual:

pip install -e .

¡Y a programar!

code .