Skip to content

email_generator

academic_doc_generator.colloquium.email_generator

Modul zur Generierung von Anmelde-E-Mails für Kolloquien.

EmailGenerator

Source code in src/academic_doc_generator/colloquium/email_generator.py 
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
class EmailGenerator:
    def __init__(self):
        """ """
        self.email_path = None
        self.email_text = None

    def generate_and_save_email(
        self,
        llm_client,
        output_folder: str,
        author: str,
        matriculation: str,
        date_colloquium: str,
        uhrzeit_colloquium: str,
        first_examiner: str,
        location_type: str = "campus",
        room: Optional[str] = None,
        company_name: Optional[str] = None,
        company_address: Optional[str] = None,
        zoom_link: Optional[str] = None,
        zcode: Optional[str] = None,
    ) -> str:
        """Generiert und speichert die Kolloquiums-Anmelde-E-Mail."""
        print("START WRITING MAIL")

        if author is None:
            print("Error: author is None")
            return ""

        student_first_name, student_last_name = split_student_name(author)

        self.generate_colloquium_email(
            llm_client=llm_client,
            student_first_name=student_first_name,
            student_last_name=student_last_name,
            id_number=matriculation,
            date_colloquium=date_colloquium,
            time_colloquium=uhrzeit_colloquium,
            first_examiner=first_examiner,
            location_type=location_type,
            room=room,
            company_name=company_name,
            company_address=company_address,
            zoom_link=zoom_link,
            zcode=zcode,
        )

        return self.save_email_to_markdown(
            output_folder=output_folder,
            student_last_name=student_last_name,
            id_number=matriculation,
        )

    def _generate_location_text(
        self,
        location_type: str,
        room: Optional[str] = None,
        company_name: Optional[str] = None,
        company_address: Optional[str] = None,
        zoom_link: Optional[str] = None,
        zcode: Optional[str] = None,
    ) -> str:
        """Generiert den Ortszusatz für die E-Mail."""
        if location_type == "campus":
            if not room:
                raise ValueError("Für Campus-Kolloquium wird 'room' benötigt")
            return f"in Raum {room} am Campus GM"

        elif location_type == "company":
            if not company_name:
                raise ValueError("Für Firmen-Kolloquium wird 'company_name' benötigt")

            if company_address:
                return f"in der Firma {company_name}, {company_address}"
            else:
                return f"in der Firma {company_name}"

        elif location_type == "online":
            if not zoom_link:
                raise ValueError("Für Online-Kolloquium wird 'zoom_link' benötigt")

            zoom_info = f"über Zoom:\n\nZoom-Link: {zoom_link}"
            if zcode:
                zoom_info += f"\nZugangscode: {zcode}"

            return zoom_info
        else:
            raise ValueError(f"Unbekannter location_type: {location_type}")

    def generate_colloquium_email(
        self,
        llm_client,
        student_first_name: str,
        student_last_name: str,
        id_number: str,
        date_colloquium: str,
        time_colloquium: str,
        first_examiner: str,
        location_type: str,
        room: Optional[str] = None,
        company_name: Optional[str] = None,
        company_address: Optional[str] = None,
        zoom_link: Optional[str] = None,
        zcode: Optional[str] = None,
    ) -> str:
        """Generiert den Text für die Kolloquiums-Anmelde-E-Mail."""
        gender = determine_gender_from_name(student_first_name, llm_client)
        student = EmailRecipient(
            first_name=student_first_name,
            last_name=student_last_name,
            gender=gender,
            identifier=id_number,
        )

        location_text = self._generate_location_text(
            location_type=location_type,
            room=room,
            company_name=company_name,
            company_address=company_address,
            zoom_link=zoom_link,
            zcode=zcode,
        )

        template = ColloquiumRegistrationEmail()
        self.email_text = template.render(
            student=student,
            examiner=first_examiner,
            date=date_colloquium,
            time=time_colloquium,
            location_text=location_text,
        )
        return self.email_text

    def generate_final_mark_email(
        self,
        evaluator_client,
        first_name: str,
        last_name: str,
        id_number: str,
        examiner_name: str,
    ) -> str:
        """Generiert den Text für die E-Mail zur Einreichung der Note."""
        gender = determine_gender_from_name(first_name, evaluator_client)
        student = EmailRecipient(
            first_name=first_name,
            last_name=last_name,
            gender=gender,
            identifier=id_number,
        )

        template = FinalGradeEmail()
        self.email_text = template.render(student=student, examiner=examiner_name)
        return self.email_text

    def generate_student_feedback_email(
        self,
        gender: str,
        last_name: str,
        mark: str,
        feedback_bulletpoints: str,
        examiner_name: str,
    ) -> str:
        """Generiert eine Feedback-E-Mail an den Studierenden."""
        student = EmailRecipient(
            first_name="",  # Not used in feedback salutation if we have last_name and gender
            last_name=last_name,
            gender=gender,
        )

        template = StudentFeedbackEmail()
        self.email_text = template.render(
            student=student,
            mark=mark,
            feedback_bulletpoints=feedback_bulletpoints,
            examiner=examiner_name,
        )
        return self.email_text

    def save_email_to_markdown(
        self,
        output_folder: str,
        student_last_name: str,
        id_number: str,
        filename_prefix: str = "kolloquium_anmeldung",
    ) -> str:
        """Speichert den E-Mail-Text in einer Markdown-Datei."""
        output_path = Path(output_folder)
        output_path.mkdir(parents=True, exist_ok=True)

        filename = f"{filename_prefix}_{student_last_name}_{id_number}.md"
        self.email_path = output_path / filename

        with open(self.email_path, "w", encoding="utf-8") as f:
            f.write(self.email_text)

        print(f"E-Mail-Text gespeichert: {self.email_path}")
        return str(self.email_path)

__init__()

Source code in src/academic_doc_generator/colloquium/email_generator.py 
18
19
20
21
def __init__(self):
    """ """
    self.email_path = None
    self.email_text = None

generate_and_save_email(llm_client, output_folder, author, matriculation, date_colloquium, uhrzeit_colloquium, first_examiner, location_type='campus', room=None, company_name=None, company_address=None, zoom_link=None, zcode=None)

Generiert und speichert die Kolloquiums-Anmelde-E-Mail.

Source code in src/academic_doc_generator/colloquium/email_generator.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def generate_and_save_email(
    self,
    llm_client,
    output_folder: str,
    author: str,
    matriculation: str,
    date_colloquium: str,
    uhrzeit_colloquium: str,
    first_examiner: str,
    location_type: str = "campus",
    room: Optional[str] = None,
    company_name: Optional[str] = None,
    company_address: Optional[str] = None,
    zoom_link: Optional[str] = None,
    zcode: Optional[str] = None,
) -> str:
    """Generiert und speichert die Kolloquiums-Anmelde-E-Mail."""
    print("START WRITING MAIL")

    if author is None:
        print("Error: author is None")
        return ""

    student_first_name, student_last_name = split_student_name(author)

    self.generate_colloquium_email(
        llm_client=llm_client,
        student_first_name=student_first_name,
        student_last_name=student_last_name,
        id_number=matriculation,
        date_colloquium=date_colloquium,
        time_colloquium=uhrzeit_colloquium,
        first_examiner=first_examiner,
        location_type=location_type,
        room=room,
        company_name=company_name,
        company_address=company_address,
        zoom_link=zoom_link,
        zcode=zcode,
    )

    return self.save_email_to_markdown(
        output_folder=output_folder,
        student_last_name=student_last_name,
        id_number=matriculation,
    )

generate_colloquium_email(llm_client, student_first_name, student_last_name, id_number, date_colloquium, time_colloquium, first_examiner, location_type, room=None, company_name=None, company_address=None, zoom_link=None, zcode=None)

Generiert den Text für die Kolloquiums-Anmelde-E-Mail.

Source code in src/academic_doc_generator/colloquium/email_generator.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def generate_colloquium_email(
    self,
    llm_client,
    student_first_name: str,
    student_last_name: str,
    id_number: str,
    date_colloquium: str,
    time_colloquium: str,
    first_examiner: str,
    location_type: str,
    room: Optional[str] = None,
    company_name: Optional[str] = None,
    company_address: Optional[str] = None,
    zoom_link: Optional[str] = None,
    zcode: Optional[str] = None,
) -> str:
    """Generiert den Text für die Kolloquiums-Anmelde-E-Mail."""
    gender = determine_gender_from_name(student_first_name, llm_client)
    student = EmailRecipient(
        first_name=student_first_name,
        last_name=student_last_name,
        gender=gender,
        identifier=id_number,
    )

    location_text = self._generate_location_text(
        location_type=location_type,
        room=room,
        company_name=company_name,
        company_address=company_address,
        zoom_link=zoom_link,
        zcode=zcode,
    )

    template = ColloquiumRegistrationEmail()
    self.email_text = template.render(
        student=student,
        examiner=first_examiner,
        date=date_colloquium,
        time=time_colloquium,
        location_text=location_text,
    )
    return self.email_text

generate_final_mark_email(evaluator_client, first_name, last_name, id_number, examiner_name)

Generiert den Text für die E-Mail zur Einreichung der Note.

Source code in src/academic_doc_generator/colloquium/email_generator.py 
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
def generate_final_mark_email(
    self,
    evaluator_client,
    first_name: str,
    last_name: str,
    id_number: str,
    examiner_name: str,
) -> str:
    """Generiert den Text für die E-Mail zur Einreichung der Note."""
    gender = determine_gender_from_name(first_name, evaluator_client)
    student = EmailRecipient(
        first_name=first_name,
        last_name=last_name,
        gender=gender,
        identifier=id_number,
    )

    template = FinalGradeEmail()
    self.email_text = template.render(student=student, examiner=examiner_name)
    return self.email_text

generate_student_feedback_email(gender, last_name, mark, feedback_bulletpoints, examiner_name)

Generiert eine Feedback-E-Mail an den Studierenden.

Source code in src/academic_doc_generator/colloquium/email_generator.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
def generate_student_feedback_email(
    self,
    gender: str,
    last_name: str,
    mark: str,
    feedback_bulletpoints: str,
    examiner_name: str,
) -> str:
    """Generiert eine Feedback-E-Mail an den Studierenden."""
    student = EmailRecipient(
        first_name="",  # Not used in feedback salutation if we have last_name and gender
        last_name=last_name,
        gender=gender,
    )

    template = StudentFeedbackEmail()
    self.email_text = template.render(
        student=student,
        mark=mark,
        feedback_bulletpoints=feedback_bulletpoints,
        examiner=examiner_name,
    )
    return self.email_text

save_email_to_markdown(output_folder, student_last_name, id_number, filename_prefix='kolloquium_anmeldung')

Speichert den E-Mail-Text in einer Markdown-Datei.

Source code in src/academic_doc_generator/colloquium/email_generator.py 
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
def save_email_to_markdown(
    self,
    output_folder: str,
    student_last_name: str,
    id_number: str,
    filename_prefix: str = "kolloquium_anmeldung",
) -> str:
    """Speichert den E-Mail-Text in einer Markdown-Datei."""
    output_path = Path(output_folder)
    output_path.mkdir(parents=True, exist_ok=True)

    filename = f"{filename_prefix}_{student_last_name}_{id_number}.md"
    self.email_path = output_path / filename

    with open(self.email_path, "w", encoding="utf-8") as f:
        f.write(self.email_text)

    print(f"E-Mail-Text gespeichert: {self.email_path}")
    return str(self.email_path)