add Readme for Grade Notifier

Author: JM-Lemmi

Readme.md

@@ -2,6 +2,37 @@
 
 ## Usage Examples
 
+### Grade Notifier with Docker
+
+This docker container will check your grade every hour and send a notification mail, if something has changed. Currently this docker container is very tailored for DHBW-Mannheim students. But feel free to broaden its usability with a PR.
+
+3 Environment variables are needed:
+
+* `USERNAME`: Your student mail address with the domain part. That is also used to login to CampusNet (Dualis)
+* `VPNUSERNAME`: Your username without the domain part. Used for the login with Anyconnect VPN, to send mails.
+* `PASSWORD`: Your account password. Used for VPN, Campusnet and Mail authentication.
+* Optional `NOTIFY_RECIPIENT`: Mail address that will receive notifications. By default the same as `USERNAME`.
+
+```
+docker run --privileged -e "USERNAME=s212689@student.dhbw-mannheim.de" -e "VPNUSERNAME=s212689" -e "PASSWORD=xxxxxxxxxxxxxxxx" ghcr.io/tinf21cs1/campusnet-grade-notifier
+```
+
+[Detailed Readme](./grades-docker/Readme.md)
+
+### Python Package
+
+You can also use CampusNet.py as an imported Package to interact in detail with CampusNet.
+
+```python
+$ python
+>>> from CampusNet import *
+>>> s = CampusNetSession("s***REMOVED***@student.dhbw-mannheim.de", "***REMOVED***")
+>>> s.modules
+[Module(num='T3_1000', name='Praxisprojekt I', credits=20.0, status='', semesters=['SoSe 2022'], id='381683598069776', grade=None), Module(num='T3INF1001', name='Mathematik I', credits=8.0, status='', semesters=['SoSe 2022', 'WiSe 2021/22'], id='380685560144022', grade=None), Module(num='T3INF1002', name='Theoretische Informatik I (MA-TINF21CS1)', credits=5.0, status='', semesters=['SoSe 2022'], id='382855008624547', grade=None), Module(num='T3INF1003', name='Theoretische Informatik II', credits=5.0, status='', semesters=['SoSe 2022'], id='382214102615788', grade=None), Module(num='T3INF1004', name='Programmieren', credits=9.0, status='', semesters=['SoSe 2022'], id='379974839816701', grade=None), Module(num='T3INF1005', name='Schlüsselqualifikationen', credits=5.0, status='', semesters=['SoSe 2022'], id='379974840574866', grade=None), Module(num='T3INF4102', name='Einführung in die Kryptologie', credits=5.0, status='', semesters=['SoSe 2022'], id='382214104541196', grade=None), Module(num='T3INF9000', name='Web and App Engineering', credits=5.0, status='', semesters=['SoSe 2022'], id='379974842066225', grade=None), Module(num='T3INF1006', name='Technische Informatik I', credits=5.0, status='bestanden', semesters=['WiSe 2021/22'], id='380703425164844', grade=1.2), Module(num='T3INF9001', name='Cyber Security Basics', credits=3.0, status='bestanden', semesters=['WiSe 2021/22'], id='379974841329087', grade=1.6)]
+>>> s.get_exams_for_module(s.modules[9])
+[Exam(semester='WiSe 2021/22', description='Hausarbeit (100%)', grade=1.6)]
+```
+
 ### Exam Script
 
 The `print_exams_as_table.py` script that is included in this repository will easily retrieve all Exams for a user and print them in a pretty table. This makes a quick overview very easy.
@@ -26,20 +57,6 @@ T3INF9001  Cyber Security Basics                     Modulabschlussleistungen
 ---------  ----------------------------------------  ------------------------------------------------------  ------------  --------------------------------------------  ---
 ```
 
-### Python Package
-
-You can also use CampusNet.py as an imported Package to interact in detail with CampusNet.
-
-```python
-$ python
->>> from CampusNet import *
->>> s = CampusNetSession("s***REMOVED***@student.dhbw-mannheim.de", "***REMOVED***")
->>> s.modules
-[Module(num='T3_1000', name='Praxisprojekt I', credits=20.0, status='', semesters=['SoSe 2022'], id='381683598069776', grade=None), Module(num='T3INF1001', name='Mathematik I', credits=8.0, status='', semesters=['SoSe 2022', 'WiSe 2021/22'], id='380685560144022', grade=None), Module(num='T3INF1002', name='Theoretische Informatik I (MA-TINF21CS1)', credits=5.0, status='', semesters=['SoSe 2022'], id='382855008624547', grade=None), Module(num='T3INF1003', name='Theoretische Informatik II', credits=5.0, status='', semesters=['SoSe 2022'], id='382214102615788', grade=None), Module(num='T3INF1004', name='Programmieren', credits=9.0, status='', semesters=['SoSe 2022'], id='379974839816701', grade=None), Module(num='T3INF1005', name='Schlüsselqualifikationen', credits=5.0, status='', semesters=['SoSe 2022'], id='379974840574866', grade=None), Module(num='T3INF4102', name='Einführung in die Kryptologie', credits=5.0, status='', semesters=['SoSe 2022'], id='382214104541196', grade=None), Module(num='T3INF9000', name='Web and App Engineering', credits=5.0, status='', semesters=['SoSe 2022'], id='379974842066225', grade=None), Module(num='T3INF1006', name='Technische Informatik I', credits=5.0, status='bestanden', semesters=['WiSe 2021/22'], id='380703425164844', grade=1.2), Module(num='T3INF9001', name='Cyber Security Basics', credits=3.0, status='bestanden', semesters=['WiSe 2021/22'], id='379974841329087', grade=1.6)]
->>> s.get_exams_for_module(s.modules[9])
-[Exam(semester='WiSe 2021/22', description='Hausarbeit (100%)', grade=1.6)]
-```
-
 ## Contribution
 
 This package is still work in progress. If you need data from CampusNet, that is currently not retrieved by it, please feel free to open an Issue or even PR for it.

grades-docker/Readme.md

@@ -1 +1,26 @@
-docker run --privileged -e "USERNAME=s212689@student.dhbw-mannheim.de" -e "VPNUSERNAME=s212689" -e "PASSWORD=xxxxxxxxxxxxxxxx" 9cccf8dd9ca9
+# Campusnet Grade Notifier
+
+This docker container will check your grade every hour and send a notification mail, if something has changed. Currently this docker container is very tailored for DHBW-Mannheim students. But feel free to broaden its usability with a PR.
+
+## Usage
+
+3 Environment variables are needed:
+
+* `USERNAME`: Your student mail address with the domain part. That is also used to login to CampusNet (Dualis)
+* `VPNUSERNAME`: Your username without the domain part. Used for the login with Anyconnect VPN, to send mails.
+* `PASSWORD`: Your account password. Used for VPN, Campusnet and Mail authentication.
+* Optional `NOTIFY_RECIPIENT`: Mail address that will receive notifications. By default the same as `USERNAME`.
+
+```
+docker run --privileged -e "USERNAME=s212689@student.dhbw-mannheim.de" -e "VPNUSERNAME=s212689" -e "PASSWORD=xxxxxxxxxxxxxxxx" ghcr.io/tinf21cs1/campusnet-grade-notifier
+```
+
+`--privileged` is needed for the VPN connection.
+
+## Process
+
+On startup a VPN connection to `drogon.dhbw-mannheim.de` is established to allow for sending mails with SMTP.
+
+Every hour a cronjob will connect to CampusNet and download the latest grades. These will be compared to the last known state, that is saved in `/app/grades.txt`
+
+If something changed, sendmail is used to send the diff to the `NOTIFIER_RECIPIENT`, via `studgate.dhbw-mannheim.de:25`, authenticated as `USERNAME`.