README.md

Debido a que he terminado las asignaturas de mi grado, la aplicación dejará de recibir actualizaciones. El repositorio queda archivado pero puede ser clonado por quien quiera y continuar su desarrollo mediante la documentación del programa.
Gracias a todos los usuarios que habéis usado y ayudado en la aplicación. <3

Esta aplicación nos permite transferir el horario de la página web de la Universidad Pompeu Fabra a un archivo JSON que automáticamente se usará para añadir los horarios a Google Calendar con el nombre de la asignatura, la clase, el inicio, el final y el tipo de clase. Para añadir eventos al calendario, se usa la Google Calendar API.

Esta aplicación no requiere que el usuario introduzca datos sensibles de inicio de sesión en el Campus Global o ningún otro tipo de información, así que en todo momento tus datos sensibles son respetados.

Índice de Contenido

1. Requisitos Previos

2. Instalación

3. Seleccionar las Preferencias

4. Ejecutar el Programa

5. Información para Desarrolladores

---

1. Requisitos Previos

• Python 3.8 o versiones superiores.

• Python Package Installer (PIP)

2. Instalación

· Instalación + Interfaz Gráfica

- MacOS, Linux & UNIX-Like Systems.

git clone https://github.com/Sklyvan/ScrapingUPF.git
cd ScrapingUPF/
pip install -r GraphicRequirements.txt 
# Si pip da error, hay que usar pip3.

- Windows

1. Descargar Repositorio.

2. Descomprimir el archivo descargado.

3. Abrir una terminal en el directorio ScrapingUPF.

4. Seguir los pasos:

cd ScrapingUPF/
pip install -r GraphicRequirements.txt 
# Si pip da error, hay que usar pip3.

· Instalación sin Interfaz Gráfica

La única diferencia para instalar sin interfaz gráfica es que no es necesario instalar los requisitos de PyQt5, solo hay que instalar lo más básico.

pip install -r CoreRequirements.txt # Si pip da error, hay que usar pip3.

3. Seleccionar las Preferencias (Este paso se puede saltar si usas la interfaz gráfica)

La selección de asignaturas se hace modificando el archivo UserPreferences.ini, no hay que modificar nada más del programa para su uso común. Solo se puede añadir una línea de cada elemento, es decir, no se pueden añadir dos PlanEstudio.
Si hay alguna duda sobre cuál es su código de su Plan de Estudio, el Plan Docente o similares, se pueden conocer mediante: Calendario y Horarios

· Connection: Este apartado solo contiene los Headers de la petición, solo es necesario para usuarios que tengan algún problema, no debería ser necesario modificar los valores que se encuentran por defecto.

· Basic Information: Este apartado contiene información genérica sobre el estudiante, hay que rellenar esos campos con la información deseada.

Nombre	Descripción	Ejemplos
PlanEstudio	Código identificador del Plan de Estudio.	PlanEstudio=634 PlanEstudio=654 PlanEstudio=635
IdiomaPais	Idioma en el que mostrar los resultados.	IdiomaPais=en.GB IdiomaPais=es.ES IdiomaPais=ca.ES
Trimestre	Trimestre del que se quieren añadir las asignaturas al calendario.	Trimestre=1 Trimestre=2 Trimestre=3
PlanDocente	Año del Plan Docente. Para el curso 2021 - 2022 es 2021.	PlanDocente=2021
CodigoCentro	Identificador del centro UPF donde se hacen las asignaturas.	CodigoCentro=337 CodigoCentro=304 CodigoCentro=331
CodigoEstudio	Código identificador de la carrera que se está cursando.	CodigoEstudio=3377 CodigoEstudio=3370 CodigoEstudio=3378
Curso	Curso del que se hacen la mayoría de asignaturas.	Curso=1 Curso=2 Curso=3 Curso=4

· Subjects Information: Información sobre cada una de las asignaturas que se quiere añadir al horario.
Se pueden añadir las asignaturas mediante dos métodos:

Método Automático

1. Clic derecho en esta página y seleccionar Guardar Como.

2. Guardar el archivo (Recomendable guardar la página web en una carpeta dentro del directorio ScrapingUPF).

3. Añadir la ubicación del archivo HTML en el archivo de preferencias.

(En este ejemplo se guarda en ScrapingUPF/res/EspaiAulaFiles/Grups.html)

⚠ En Windows es recomendable añadir la ruta completa del archivo como por ejemplo C:/Users/Grups.html
⚠ Es importante añadir las barras de separación de directorios como / y no como "".
⚠ Se recomienda no usar ni tildes ni ñ en el EspaiAulaFilePath.

[SUBJECTS_INFORMATION]
Asignaturas=False
GruposAsignaturas=False
GruposPracticas=False
GruposSeminarios=False
EspaiAulaFilePath=../res/EspaiAulaFiles/Grups.html

Método Manual

Se pueden añadir tantas asignaturas como se quiera siempre que:

1. Para toda asignatura se añada un grupo de teoría, uno de prácticas y uno de seminarios. En caso de que no haya uno de ellos, hay que poner un código inventado igualmente.

2. Los valores deben estar separados por comas y sin espacios.

Para añadir la asignatura Bases de Datos (24303), del grupo 2 de teorías, 201 de prácticas y 202 de seminarios:

[SUBJECTS_INFORMATION]
Asignaturas=24303
GruposAsignaturas=2
GruposPracticas=201
GruposSeminarios=202
EspaiAulaFilePath=False

Si se quiere añadir también Inteligencia Artificial (24304) con el grupo 1 de teorías, 101 de prácticas y 102 de seminarios:

[SUBJECTS_INFORMATION]
Asignaturas=24303,24304
GruposAsignaturas=2,1
GruposPracticas=201,101
GruposSeminarios=202,102
EspaiAulaFilePath=False

· Fechas: Estas fechas determinan a partir de que día y hasta que día queremos guardar los horarios. Las dos fechas deben estar en formato DD/MM/YY.

Si queremos añadir las asignaturas de solo el de 10 de Octubre de 2021:

[DATES]
Inicio=10/10/2021
Final=10/10/2021

Si queremos añadir todo el mes de Octubre:

[DATES]
Inicio=01/10/2021
Final=31/10/2021

4. Ejecutar el Programa

Para ejecutar el programa simplemente hay que lanzar el archivo Main.py mediante Python:

cd src
python3 MainWindow.py

En caso de querer usar el programa sin interfaz gráfica:

cd src
python3 Application.py

Al añadir las asignaturas, el programa se va a abrir una ventana con nuestro buscador que nos va a pedir autorización para la API de Google Calendar.

5. Información para Desarrolladores

El producto ha sido desarrollado bajo la licencia GNU General Public License 3, por lo que se permite la modificación del mismo, su distribución y su uso privado, siempre que el código siga siendo completamente abierto y público tal y como obliga su licencia.
El archivo de credenciales de la API de Google Calendar es totalmente pública, de manera que se puede seguir usando la misma API para proyectos basados en esta.
Si por alguna razón se necesita modificar la licencia, contacte con el autor del programa.
En caso de que se quiera contribuir con el código, es recomendable leer la documentación del programa.

Posibles Contribuciones

· Generar binarios para Windows y MacOS.
· Modificar el funcionamiento de la barra de carga.
· Buscar un método para que el usuario solo tenga que añadir las asignaturas.
· Modo Oscuro de la Interfaz Gráfica Qt5.

Contacto

Cualquier duda, consulta o problema:
E-Mail: joan.gracia01@estudiant.upf.edu
Discord: Sklyvan #3902