Skip to content

calendar_generator

academic_doc_generator.colloquium.calendar_generator

Modul zur Generierung von ICS-Kalender-Dateien für Kolloquiumstermine.

CalendarGenerator

Erstellt ICS-Kalender-Dateien für Kolloquiumstermine.

Source code in src/academic_doc_generator/colloquium/calendar_generator.py 
  8
  9
 10
 11
 12
 13
 14
 15
 16
 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
class CalendarGenerator:
    """Erstellt ICS-Kalender-Dateien für Kolloquiumstermine."""

    def __init__(self):
        """Initialisiert den CalendarGenerator."""
        self.ics_path = None

    def generate_ics(
        self,
        output_folder: str,
        student_name: str,
        date_colloquium: str,
        time_colloquium: str,
        duration_minutes: int = 45,
        location_type: str = "campus",
        room: Optional[str] = None,
        company_name: Optional[str] = None,
        company_address: Optional[str] = None,
    ) -> str:
        """Generiert eine ICS-Kalender-Datei für das Kolloquium.

        Args:
            output_folder: Ausgabeordner für die ICS-Datei.
            student_name: Name des Studierenden.
            date_colloquium: Datum im Format "DD.MM.YYYY".
            time_colloquium: Uhrzeit im Format "HH:MM".
            duration_minutes: Dauer des Kolloquiums in Minuten (Standard: 45).
            location_type: "campus", "company" oder "online".
            room: Raumnummer (für Campus).
            company_name: Firmenname (für Firma).
            company_address: Firmenadresse (für Firma).

        Returns:
            Pfad zur erstellten ICS-Datei.
        """
        # Parse Datum und Uhrzeit
        dt_start = datetime.strptime(f"{date_colloquium} {time_colloquium}", "%d.%m.%Y %H:%M")
        dt_end = dt_start + timedelta(minutes=duration_minutes)

        # Formatiere für ICS (Format: YYYYMMDDTHHMMSS)
        start_str = dt_start.strftime("%Y%m%dT%H%M%S")
        end_str = dt_end.strftime("%Y%m%dT%H%M%S")

        # Erstelle Zeitstempel für UID und DTSTAMP
        now = datetime.now().strftime("%Y%m%dT%H%M%SZ")

        # Erstelle Location-String
        location = self._generate_location_string(
            location_type=location_type,
            room=room,
            company_name=company_name,
            company_address=company_address,
        )

        # Erstelle ICS-Inhalt
        ics_content = f"""BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//TH Köln//Kolloquium//DE
CALSCALE:GREGORIAN
METHOD:PUBLISH
BEGIN:VEVENT
UID:kolloquium-{student_name.replace(" ", "-").replace(",", "")}-{now}@th-koeln.de
DTSTAMP:{now}
DTSTART:{start_str}
DTEND:{end_str}
SUMMARY:Kolloquium {student_name}
LOCATION:{location}
DESCRIPTION:Kolloquium für {student_name}
STATUS:CONFIRMED
SEQUENCE:0
BEGIN:VALARM
TRIGGER:-PT30M
ACTION:DISPLAY
DESCRIPTION:Erinnerung: Kolloquium {student_name} in 30 Minuten
END:VALARM
BEGIN:VALARM
TRIGGER:-P1D
ACTION:DISPLAY
DESCRIPTION:Erinnerung: Kolloquium {student_name} morgen
END:VALARM
END:VEVENT
END:VCALENDAR"""

        # Speichere ICS-Datei
        output_path = Path(output_folder)
        output_path.mkdir(parents=True, exist_ok=True)

        # Bereinige Dateinamen (entferne Kommas und Leerzeichen)
        safe_name = student_name.replace(",", "").replace(" ", "_")
        filename = f"kolloquium_{safe_name}.ics"
        self.ics_path = output_path / filename

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

        print(f"✅ Kalender-Datei erstellt: {self.ics_path}")
        return str(self.ics_path)

    def _generate_location_string(
        self,
        location_type: str,
        room: Optional[str] = None,
        company_name: Optional[str] = None,
        company_address: Optional[str] = None,
    ) -> str:
        """Generiert den Location-String für die ICS-Datei.

        Args:
            location_type: Art des Kolloquiums ("campus", "company", "online").
            room: Raumnummer (nur für "campus").
            company_name: Name der Firma (nur für "company").
            company_address: Adresse der Firma (nur für "company").

        Returns:
            Location-String für ICS-Datei.

        Raises:
            ValueError: Wenn erforderliche Parameter fehlen.
        """
        if location_type == "campus":
            if not room:
                raise ValueError("Für Campus-Kolloquium wird 'room' benötigt")
            return f"Raum {room}, Campus Gummersbach, Steinmüllerallee 1, 51643 Gummersbach"

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

            if company_address:
                return f"{company_name}, {company_address}"
            else:
                return company_name

        elif location_type == "online":
            return "Online (Zoom)"

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

__init__()

Initialisiert den CalendarGenerator.

Source code in src/academic_doc_generator/colloquium/calendar_generator.py 
11
12
13
def __init__(self):
    """Initialisiert den CalendarGenerator."""
    self.ics_path = None

generate_ics(output_folder, student_name, date_colloquium, time_colloquium, duration_minutes=45, location_type='campus', room=None, company_name=None, company_address=None)

Generiert eine ICS-Kalender-Datei für das Kolloquium.

Parameters:

Name Type Description Default
output_folder str

Ausgabeordner für die ICS-Datei.

 required
student_name str

Name des Studierenden.

 required
date_colloquium str

Datum im Format "DD.MM.YYYY".

 required
time_colloquium str

Uhrzeit im Format "HH:MM".

 required
duration_minutes int

Dauer des Kolloquiums in Minuten (Standard: 45).

 45
location_type str

"campus", "company" oder "online".

 'campus'
room Optional[str]

Raumnummer (für Campus).

 None
company_name Optional[str]

Firmenname (für Firma).

 None
company_address Optional[str]

Firmenadresse (für Firma).

 None

Returns:

Type Description
str

Pfad zur erstellten ICS-Datei.
Source code in src/academic_doc_generator/colloquium/calendar_generator.py 
 15
 16
 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
    def generate_ics(
        self,
        output_folder: str,
        student_name: str,
        date_colloquium: str,
        time_colloquium: str,
        duration_minutes: int = 45,
        location_type: str = "campus",
        room: Optional[str] = None,
        company_name: Optional[str] = None,
        company_address: Optional[str] = None,
    ) -> str:
        """Generiert eine ICS-Kalender-Datei für das Kolloquium.

        Args:
            output_folder: Ausgabeordner für die ICS-Datei.
            student_name: Name des Studierenden.
            date_colloquium: Datum im Format "DD.MM.YYYY".
            time_colloquium: Uhrzeit im Format "HH:MM".
            duration_minutes: Dauer des Kolloquiums in Minuten (Standard: 45).
            location_type: "campus", "company" oder "online".
            room: Raumnummer (für Campus).
            company_name: Firmenname (für Firma).
            company_address: Firmenadresse (für Firma).

        Returns:
            Pfad zur erstellten ICS-Datei.
        """
        # Parse Datum und Uhrzeit
        dt_start = datetime.strptime(f"{date_colloquium} {time_colloquium}", "%d.%m.%Y %H:%M")
        dt_end = dt_start + timedelta(minutes=duration_minutes)

        # Formatiere für ICS (Format: YYYYMMDDTHHMMSS)
        start_str = dt_start.strftime("%Y%m%dT%H%M%S")
        end_str = dt_end.strftime("%Y%m%dT%H%M%S")

        # Erstelle Zeitstempel für UID und DTSTAMP
        now = datetime.now().strftime("%Y%m%dT%H%M%SZ")

        # Erstelle Location-String
        location = self._generate_location_string(
            location_type=location_type,
            room=room,
            company_name=company_name,
            company_address=company_address,
        )

        # Erstelle ICS-Inhalt
        ics_content = f"""BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//TH Köln//Kolloquium//DE
CALSCALE:GREGORIAN
METHOD:PUBLISH
BEGIN:VEVENT
UID:kolloquium-{student_name.replace(" ", "-").replace(",", "")}-{now}@th-koeln.de
DTSTAMP:{now}
DTSTART:{start_str}
DTEND:{end_str}
SUMMARY:Kolloquium {student_name}
LOCATION:{location}
DESCRIPTION:Kolloquium für {student_name}
STATUS:CONFIRMED
SEQUENCE:0
BEGIN:VALARM
TRIGGER:-PT30M
ACTION:DISPLAY
DESCRIPTION:Erinnerung: Kolloquium {student_name} in 30 Minuten
END:VALARM
BEGIN:VALARM
TRIGGER:-P1D
ACTION:DISPLAY
DESCRIPTION:Erinnerung: Kolloquium {student_name} morgen
END:VALARM
END:VEVENT
END:VCALENDAR"""

        # Speichere ICS-Datei
        output_path = Path(output_folder)
        output_path.mkdir(parents=True, exist_ok=True)

        # Bereinige Dateinamen (entferne Kommas und Leerzeichen)
        safe_name = student_name.replace(",", "").replace(" ", "_")
        filename = f"kolloquium_{safe_name}.ics"
        self.ics_path = output_path / filename

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

        print(f"✅ Kalender-Datei erstellt: {self.ics_path}")
        return str(self.ics_path)