New branch march 22 2024

Report_Generator/report_generator_streamlit.py

@@ -0,0 +1,150 @@
+import streamlit as st
+from docxtpl import DocxTemplate
+import datetime
+from pathlib import Path
+import os
+import sys
+
+def resource_path(relative_path):
+    try:
+        base_path = sys._MEIPASS
+    except Exception:
+        base_path = os.path.abspath(".")
+
+    return os.path.join(base_path, relative_path)
+
+def validate_input(input_value):
+    if input_value in ['--', 'NA']:
+        return True
+    try:
+        float(input_value)
+        return True
+    except ValueError:
+        return False
+
+def main():
+    st.title("📑 Futur Idiomes - Report Generator (v0.5)")
+
+    # Form inputs
+    student = st.text_input("Student:")
+    level = st.selectbox("Level:", [
+        "Young Learners", "Starters", "Movers", "Flyers", 
+        "KET", "PET", "FCE"
+    ])
+    teacher = st.text_input("Teacher:")
+    period = st.selectbox("Periodo:", [
+        "1er Trimestre", "2ndo Trimestre", "3er Trimestre"
+    ])
+    # ========================================================================================
+    # GENERAL MARKS
+
+    st.markdown("### General Marks")
+    col1, col2 = st.columns(2)
+
+    with col1:
+        asistencia = st.number_input("Asistencia:", min_value=1, max_value=10)
+        asimilacion = st.number_input("Asimilación de material nuevo:", min_value=1, max_value=10)
+        aprendizaje = st.number_input("Aprendizaje/Deberes:", min_value=1, max_value=10)
+
+    with col2:
+        participacion = st.number_input("Participación en clase/Interés:", min_value=1, max_value=10)
+        comportamiento = st.number_input("Comportamiento:", min_value=1, max_value=10)
+        progreso = st.number_input("Progreso durante del trimestre:", min_value=1, max_value=10)
+    # ========================================================================================
+
+    # ========================================================================================
+    # EXAM MARKS
+    st.markdown("### Exam Marks")
+    prueba = st.selectbox("Prueba:", [
+        "Trimestral", "Final", "Final (Simulación de examen FCE)"
+    ])
+    st.info("'--' -> no se evaluó en la prueba | 'NA' -> no asistió a la prueba")
+
+    col3, col4 = st.columns(2)
+
+    with col3:
+        listening = st.number_input("Listening:", value=0.0, step=1.0, format='%f', max_value=10.0)
+        reading_use_language = st.number_input("Reading and Use of Language:", value=0.0, step=1.0, format='%f', max_value=10.0)
+    with col4:
+        writing = st.number_input("Writing:", value=0.0, step=1.0, format='%f', max_value=10.0)
+        speaking = st.number_input("Speaking:", value=0.0, step=1.0, format='%f', max_value=10.0)
+    # ========================================================================================
+
+    st.markdown("### Comentario")
+    comentario = st.text_area("Comentario:", height=100, max_chars=350)
+
+    despedida = st.text_input("Despedida:", "¡Felices Vacaciones!")
+
+    if st.button("Generate Report"):
+
+        # Validate inputs
+        general_marks_valid = all(validate_input(mark) for mark in [
+            asistencia, asimilacion, aprendizaje, participacion, 
+            comportamiento, progreso
+        ])
+        exam_marks_valid = all(validate_input(mark) for mark in [
+            listening, reading_use_language, writing, speaking
+        ])
+
+        if general_marks_valid and exam_marks_valid:
+            generate_report(student, level, teacher, period, asistencia, asimilacion, 
+                            aprendizaje, participacion, comportamiento, progreso, prueba, 
+                            listening, reading_use_language, writing, speaking, comentario, 
+                            despedida)
+
+        # TODO: Clear inputs that vary (e.g. student)
+
+        else:
+            st.error("Please enter valid marks (numbers, '--', or 'NA')")
+
+    st.markdown("##### Made with ❤️ by [Gero Zayas](https://www.gerozayas.com)")
+
+
+
+def generate_report(student, level, teacher, period, asistencia, asimilacion, 
+                    aprendizaje, participacion, comportamiento, progreso, prueba, 
+                    listening, reading_use_language, writing, speaking, comentario, 
+                    despedida):
+    document_path = resource_path(Path(__file__).parent / "./model.docx")
+    doc = DocxTemplate(document_path)
+
+    values = {
+        "STUDENT": student,
+        "LEVEL": level,
+        "TEACHER": teacher,
+        "PERIOD": period,
+        "ASISTENCIA": asistencia,
+        "ASIMILACION": asimilacion,
+        "APRENDIZAJE": aprendizaje,
+        "PARTICIPACION": participacion,
+        "COMPORTAMIENTO": comportamiento,
+        "PROGRESO": progreso,
+        "PRUEBA": prueba,
+        "LISTENING": listening,
+        "READING_USE_LANGUAGE": reading_use_language,
+        "WRITING": writing,
+        "SPEAKING": speaking,
+        "COMENTARIO": comentario,
+        "DESPEDIDA": despedida
+    }
+
+    try:
+        result_total = (
+            float(values["LISTENING"])
+            + float(values["READING_USE_LANGUAGE"])
+            + float(values["WRITING"])
+            + float(values["SPEAKING"])
+        ) / 4
+        values["TOTAL"] = round(result_total, 1)
+    except Exception:
+        values["TOTAL"] = "..."
+
+    doc.render(values)
+    output_path = f"./00_GENERATED_REPORTS/{values['STUDENT']}-{values['LEVEL']}.docx"
+    doc.save(output_path)
+
+
+    st.success(f"File has been saved! Path: {output_path}")
+
+if __name__ == "__main__":
+    main()

Report_Generator/report_generator_v0_4.py

@@ -16,7 +16,6 @@
 
 
 def main():
-
     # To understand this solution applying this function of resource_path go to->
     # https://stackoverflow.com/questions/31836104/pyinstaller-and-onefile-how-to-include-an-image-in-the-exe-file
     # specifically to "A clear and unambiguous guide"
@@ -64,7 +63,7 @@ def resource_path(relative_path):
     PERIODOS = ["1er Trimestre", "2ndo Trimestre", "3er Trimestre"]
 
     # Fonts
-    FONT = "Consolas 12"
+    FONT = "Agave 11"
     TEXT_SIZE = (22, 1)
     TOOLTIP_EXAM_MARKS = (
         "'--': no se evaluó en la prueba | 'NA': no asistió a la prueba"
@@ -241,7 +240,6 @@ def resource_path(relative_path):
             sg.theme(selected_theme)
 
         if event == "GENERATE":
-
             try:
                 result_total = (
                     float(values["LISTENING"])

requirements.txt

@@ -0,0 +1,43 @@
+altair==5.3.0
+attrs==23.2.0
+blinker==1.8.2
+cachetools==5.3.3
+certifi==2024.6.2
+charset-normalizer==3.3.2
+click==8.1.7
+gitdb==4.0.11
+gitpython==3.1.43
+idna==3.7
+jinja2==3.1.4
+jsonschema==4.22.0
+jsonschema-specifications==2023.12.1
+markdown-it-py==3.0.0
+markupsafe==2.1.5
+mdurl==0.1.2
+numpy==1.26.4
+packaging==24.0
+pandas==2.2.2
+pillow==10.3.0
+pip==24.0
+protobuf==4.25.3
+pyarrow==16.1.0
+pydeck==0.9.1
+pygments==2.18.0
+python-dateutil==2.9.0.post0
+pytz==2024.1
+referencing==0.35.1
+requests==2.32.3
+rich==13.7.1
+rpds-py==0.18.1
+six==1.16.0
+smmap==5.0.1
+streamlit==1.35.0
+tenacity==8.3.0
+toml==0.10.2
+toolz==0.12.1
+tornado==6.4.1
+typing-extensions==4.12.2
+tzdata==2024.1
+urllib3==2.2.1
+uv==0.2.9
+watchdog==4.0.1