How siro098/vorlesungsfortschritt works
Project Type and Purpose
• This is a small desktop‐widget style application that calculates and displays the current progress of a DHBW lecture in percent.
• The “backend” is a Python script (Vorlesungsfortschritt.py) that parses .ics calendar data. The “frontend” is a Rainmeter skin (Vorlesungsfortschritt.ini) which runs on Windows and renders text/graphics on the desktop.
• A setup utility (setup.py) ties everything together by installing fonts, writing configuration, and placing files where Rainmeter expects them.
File‐Structure Analysis
• Top‐level:
• .github/ISSUE_TEMPLATE – issue templates for GitHub, not part of runtime
• FondsInstalls/ – TrueType/OpenType font files to install for the Rainmeter skin
• README.md, LICENSE – documentation and license
• setup.py – installer/configurator that writes config.txt and copies the Rainmeter skin files into the Rainmeter directory
• Vorlesungsfortschritt.py – core Python logic
• Vorlesungsfortschritt.ini – Rainmeter skin definition (in project root)
• config.txt – stores user’s chosen course, wallpaper‐sync file path, thresholds, etc.
• ical/ – holds downloaded or prepopulated .ics files from DHBW.app
• txtfiles/ – text files (Bar.txt, Zahl.txt, Vorlesung.txt) used as the data exchange interface between Python and Rainmeter
Key Insights from README
• The Python script is triggered automatically by Rainmeter (using its “Run command” plugin or measure type).
• The script reads .ics calendar entries, computes percent complete, and writes three small text files for skin measures.
• Setup.py locates the user’s Rainmeter skin folder, installs fonts, writes config.txt, and places the .ini file.
Components
a. Main Components
• ICS Data Source (DHBW.app feed or local .ics under ical/)
• Python Processor (Vorlesungsfortschritt.py)
• Local Config Store (config.txt)
• Text‐file Bridge (txtfiles/Bar.txt, Zahl.txt, Vorlesung.txt)
• Rainmeter Skin (Vorlesungsfortschritt.ini)
• Font Assets (FondsInstalls/ → OS Font Directory)
• Setup Utility (setup.py)
• Execution Environment: Python 3.x runtime & Rainmeter application
b. Relationships & Data Flow
1. Setup.py reads user input → writes config.txt + copies .ini and font files → installs fonts.
2. Rainmeter (Scheduler/Measure) invokes Vorlesungsfortschritt.py at intervals.
3. Python script reads:
– config.txt for course name & settings
– .ics files under ical/
Processes progress → writes to the three text files in txtfiles/.
4. Rainmeter skin measures read the three text files to update on‐screen meters (text, progress bar, percentage).
5. User sees desktop widget reflecting real‐time lecture progress.
c. Architectural Patterns & Principles
• Separation of Concerns:
• Data acquisition & computation in Python
• Presentation in Rainmeter UI
• File‐based IPC: Text files as a simple, robust bridge for data sharing on a single machine.
• Config Management: Single flat file (config.txt) to store user preferences.
d. Technologies & Frameworks
• Python 3.8–3.13
• Rainmeter (Windows desktop skin framework)
• iCalendar format (.ics)
• OS fonts (TTF/OTF)
• Simple flat‐file I/O for IPC