zermelo-api-vogk 0.2.16__tar.gz

zermelo_api_vogk-0.2.16/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Klaas Vogel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

zermelo_api_vogk-0.2.16/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.1
+Name: zermelo_api_vogk
+Version: 0.2.16
+Summary: A small module to create a Zermelo accesstoken and put some data from Zermelo in dataclasses
+Home-page: https://github.com/KlaasVogel/zermelo_api_vogk
+Author: Klaas Vogel
+Author-email: zermelo_api@klaasvogel.nl
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+License-File: LICENSE
+
+## zermelo_api_vogk
+A small module to create a Zermelo accesstoken and put some data from Zermelo in dataclasses
+
+# V0.2.16
+ - found bug when running as daemon, probably: logger.
+ - try without output to file
+
+# V0.2.15
+ - disabled debug mode
+
+# V0.2.14
+ - debug on for bugfixing
+ - added extra debug log for filter in lesgroepen
+ - edit filter to find second part of groupname in les.groups
+
+# V0.2.13
+ - New bug: loading of stamgroepen as lesgroep is broken!
+ - need to update/edit filter in lesgroepen
+
+# V0.2.12
+ - removed debug for wisa and lesgroepen
+
+# V0.2.11
+ - added groep.extendentName to filter in lesgroep
+
+# V0.2.10
+ - trying to optimize lesgroepen
+ - added (temp) debug to lesgroepen
+ - log group
+
+# V0.2.9
+ - removed dependency of Groepen in Vakken (ot used)
+ - added getName to Vak (Vakken)
+ - start cleanup code
+
+# V0.2.8
+ - changed definition of Vakken and Groepen in Branch
+ - added Vakken & Vak to __init__.py 
+
+# V0.2.7
+ - added response as data in getData on wrong output
+ - refactoring of Appointments
+  * added function: get_department_updates [doesn't work atm :( ]
+
+# V0.2.6
+ - removed linebreaks from logger.write()
+
+# V0.2.5
+ - trying getting extra data for each appointment from user
+ - changed "with_id" in get_data to "from_id" and reversed functionality for better readability
+ - added classmethod to Appointment to get Appointment direct from id
+
+# V0.2.4
+ - added getting appointments
+
+# V0.2.3
+ - changed getting lesgroepen only as return so not part of branch anymore
+ - removed lastcheck from lesgroepen
+
+# V0.2.2
+ - bugfix lesgroepen
+ - added write to logger (debug)
+ - changed repr of Users
+
+# V0.2.1
+ - added datetime to each branch
+ - init of branches is now only datestring, year will be determined internally
+
+# V0.2.0
+ - changed decorator from_zermelo_dict to function
+
+# V0.1.3
+- added lesgroepen
+
+# V0.1.2
+- added Vakken
+
+# V0.1.1
+  - added groepen / groups
+  - First setup of vakken
+  - cleanup of code
+
+# V0.1.0: First Refactoring already:
+- deleted fields.py and moved usefull functions to zermelo_api
+- loading of data for (zermelo)list generalized in zermelo_api
+
+# V0.0.8:
+ - Added loading of Users (Leerlingen & Medewerkers)
+ - Added backtracker to MyLogger
+
+# V0.0.7:
+- Added Loading of Branches
+
+# V0.0.1 -> V0.0.5:
+- Experimenting with creating of own package and major structure of project

zermelo_api_vogk-0.2.16/README.md

@@ -0,0 +1,95 @@
+## zermelo_api_vogk
+A small module to create a Zermelo accesstoken and put some data from Zermelo in dataclasses
+
+# V0.2.16
+ - found bug when running as daemon, probably: logger.
+ - try without output to file
+
+# V0.2.15
+ - disabled debug mode
+
+# V0.2.14
+ - debug on for bugfixing
+ - added extra debug log for filter in lesgroepen
+ - edit filter to find second part of groupname in les.groups
+
+# V0.2.13
+ - New bug: loading of stamgroepen as lesgroep is broken!
+ - need to update/edit filter in lesgroepen
+
+# V0.2.12
+ - removed debug for wisa and lesgroepen
+
+# V0.2.11
+ - added groep.extendentName to filter in lesgroep
+
+# V0.2.10
+ - trying to optimize lesgroepen
+ - added (temp) debug to lesgroepen
+ - log group
+
+# V0.2.9
+ - removed dependency of Groepen in Vakken (ot used)
+ - added getName to Vak (Vakken)
+ - start cleanup code
+
+# V0.2.8
+ - changed definition of Vakken and Groepen in Branch
+ - added Vakken & Vak to __init__.py 
+
+# V0.2.7
+ - added response as data in getData on wrong output
+ - refactoring of Appointments
+  * added function: get_department_updates [doesn't work atm :( ]
+
+# V0.2.6
+ - removed linebreaks from logger.write()
+
+# V0.2.5
+ - trying getting extra data for each appointment from user
+ - changed "with_id" in get_data to "from_id" and reversed functionality for better readability
+ - added classmethod to Appointment to get Appointment direct from id
+
+# V0.2.4
+ - added getting appointments
+
+# V0.2.3
+ - changed getting lesgroepen only as return so not part of branch anymore
+ - removed lastcheck from lesgroepen
+
+# V0.2.2
+ - bugfix lesgroepen
+ - added write to logger (debug)
+ - changed repr of Users
+
+# V0.2.1
+ - added datetime to each branch
+ - init of branches is now only datestring, year will be determined internally
+
+# V0.2.0
+ - changed decorator from_zermelo_dict to function
+
+# V0.1.3
+- added lesgroepen
+
+# V0.1.2
+- added Vakken
+
+# V0.1.1
+  - added groepen / groups
+  - First setup of vakken
+  - cleanup of code
+
+# V0.1.0: First Refactoring already:
+- deleted fields.py and moved usefull functions to zermelo_api
+- loading of data for (zermelo)list generalized in zermelo_api
+
+# V0.0.8:
+ - Added loading of Users (Leerlingen & Medewerkers)
+ - Added backtracker to MyLogger
+
+# V0.0.7:
+- Added Loading of Branches
+
+# V0.0.1 -> V0.0.5:
+- Experimenting with creating of own package and major structure of project

zermelo_api_vogk-0.2.16/app/zermelo_api/__init__.py

@@ -0,0 +1,8 @@
+from .src.zermelo_api import ZermeloAPI
+from .src.branches import Branch, Branches
+from .src.time_utils import *
+from .src.users import Leerling, Medewerker, Leerlingen, Personeel
+from .src.lesgroepen import Lesgroepen, Lesgroep
+from .src.leerjaren import Leerjaar, Leerjaren
+from .src.appointments import get_user_appointments, get_department_updates, Appointment
+from .src.vakken import Vakken, Vak

zermelo_api_vogk-0.2.16/app/zermelo_api/src/appointments.py

@@ -0,0 +1,92 @@
+from .zermelo_api import zermelo, from_zermelo_dict
+from dataclasses import dataclass, InitVar, field
+from logger import makeLogger, DEBUG
+
+logger = makeLogger("APPS")
+
+
+@dataclass
+class Appointment:
+    id: int
+    appointmentInstance: int = 0
+    start: int = 0
+    end: int = 0
+    startTimeSlot: int = 0
+    endTimeSlot: int = 0
+    branch: int = 0
+    type: str = "unknown"
+    groupsInDepartments: list[int] = field(default_factory=list)
+    locationsOfBranch: list[int] = field(default_factory=list)
+    locations: list[str] = field(default_factory=list)
+    optional: bool = False
+    valid: bool = False
+    cancelled: bool = False
+    cancelledReason: str = ""
+    modified: bool = False
+    teacherChanged: bool = False
+    groupChanged: bool = False
+    locationChanged: bool = False
+    timeChanged: bool = False
+    moved: bool = False
+    created: int = 0
+    hidden: bool = False
+    commonSchedule: bool = False
+    ignoreSubstitutions: bool = False
+    changeDescription: str = ""
+    schedulerRemark: str = ""
+    capacity: int = 0
+    content: str = ""
+    lastModified: int = 0
+    new: bool = True
+    choosableInDepartments: list[int] = field(default_factory=list)
+    choosableInDepartmentCodes: list[str] = field(default_factory=list)
+    courses: list[int] = field(default_factory=list)
+    alternativeSubject: str = ""
+    onlineStudents: list[str] = field(default_factory=list)
+    extraStudentSource: str = ""
+    appointmentLastModified: int = 0
+    onlineLocationUrl: str = ""
+    remark: str = ""
+    capacityManually: bool = False
+    teachingTimeManually: bool = False
+    teachingTime: int = 0
+    expectedStudentCount: int = 0
+    expectedStudentCountOnline: int = 0
+    availableSpace: int = 0
+    udmUUID: str = ""
+    creator: str = ""
+    subjects: list[str] = field(default_factory=list)
+    teachers: list[int] = field(default_factory=list)
+    onlineTeachers: list[str] = field(default_factory=list)
+    students: list[str] = field(default_factory=list)
+
+    # doesn't work (not enough rights)
+    # @classmethod
+    # def get_appointment(cls, id: int):
+    #     query = f"appointments/{id}"
+    #     status, data = zermelo.getData(query, from_id=True)
+    #     if status != 200:
+    #         raise Exception(data)
+    #     return from_zermelo_dict(cls, data[0])
+
+
+def get_appointments(query: str) -> list[Appointment]:
+    status, data = zermelo.getData(query)
+    if status != 200:
+        raise Exception(data)
+    return [from_zermelo_dict(Appointment, row) for row in data]
+
+
+def get_user_appointments(user: int | str, **kwargs) -> list[Appointment]:
+    query = f"appointments/?user={user}"
+    for key, val in kwargs.items():
+        query += f"&{key}={val}"
+    logger.debug(query)
+    return get_appointments(query)
+
+
+def get_department_updates(id: int, **kwargs) -> list[Appointment]:
+    query = f"appointments/?containsStudentsFromGroupInDepartment={id}"
+    for key, val in kwargs.items():
+        query += f"&{key}={val}"
+    return get_appointments(query)

zermelo_api_vogk-0.2.16/app/zermelo_api/src/branches.py

@@ -0,0 +1,93 @@
+from .logger import makeLogger
+from .zermelo_api import ZermeloCollection, zermelo, from_zermelo_dict
+from .time_utils import get_date, get_year, datetime
+from .users import Leerling, Leerlingen, Personeel, Medewerker
+from .leerjaren import Leerjaren, Leerjaar
+from .groepen import Groep, Groepen
+from .lesgroepen import Lesgroepen, Lesgroep
+from .vakken import Vakken, Vak
+from dataclasses import dataclass, InitVar, field
+
+# branch is roughly translated to 'afdeling' in Dutch
+# for readability kept as branch, might be changed in the future
+
+logger = makeLogger("BRANCH")
+
+
+@dataclass
+class SchoolInSchoolYear:
+    id: int
+    # school: int
+    # year: int
+    # archived: bool
+    # name: str
+    # projectName: str
+    # schoolName: str
+    # schoolHrmsCode: str
+
+
+@dataclass
+class Branch:
+    id: int
+    schoolInSchoolYear: int
+    branch: str
+    name: str
+    schoolYear: int
+    date: datetime = datetime.now()
+    leerlingen: list[Leerling] = field(default_factory=list)
+    personeel: list[Medewerker] = field(default_factory=list)
+    leerjaren: list[Leerjaar] = field(default_factory=list)
+    vakken: Vakken = field(default_factory=list)
+    groepen: Groepen = field(default_factory=list)
+
+    def __post_init__(self):
+        logger.info(f"*** loading branch: {self.name} ***")
+        self.leerlingen = Leerlingen(self.schoolInSchoolYear)
+        self.personeel = Personeel(self.schoolInSchoolYear)
+        self.leerjaren = Leerjaren(self.schoolInSchoolYear)
+        self.groepen = Groepen(self.schoolInSchoolYear)
+        self.vakken = Vakken(self.schoolInSchoolYear)
+
+    def find_lesgroepen(self) -> Lesgroepen | bool:
+        if self.leerlingen and self.personeel:
+            return Lesgroepen(
+                self.leerjaren,
+                self.vakken,
+                self.groepen,
+                self.leerlingen,
+                self.personeel,
+            )
+        return False
+
+
+@dataclass
+class Branches(ZermeloCollection, list[Branch]):
+    datestring: InitVar = ""
+
+    def __post_init__(self, datestring):
+        logger.debug("init branches")
+        date = get_date(datestring)
+        year = get_year(datestring)
+        logger.debug(year)
+        query = f"schoolsinschoolyears/?year={year}&archived=False"
+        data = zermelo.load_query(query)
+        for schoolrow in data:
+            school = from_zermelo_dict(SchoolInSchoolYear, schoolrow)
+            query = f"branchesofschools/?schoolInSchoolYear={school.id}"
+            self.load_collection(query, Branch)
+        for branch in self:
+            branch.date = date
+
+    def __str__(self):
+        return "Branches(" + ", ".join([br.name for br in self]) + ")"
+
+    def get(self, name: str) -> Branch:
+        logger.info(f"loading branch: {name} ")
+        for branch in self:
+            if (
+                name.lower() in branch.branch.lower()
+                or branch.branch.lower() in name.lower()
+            ):
+                return branch
+        else:
+            logger.error(f"NO Branch found for {name}")

zermelo_api_vogk-0.2.16/app/zermelo_api/src/config.py

@@ -0,0 +1,52 @@
+from os import path, mkdir
+from shutil import copyfile
+import json
+
+
+class getConfig:
+    def __init__(self, file):
+        HOMEDIR = getConfigDir()
+        filename = file + ".json"
+        backupname = file + ".bak"
+        if not HOMEDIR:
+            raise Exception("Kan configuratie directory niet aanmaken")
+        self.filepath = path.join(HOMEDIR, filename)
+        self.backup = path.join(HOMEDIR, backupname)
+
+    def __repr__(self):
+        return f'ConfigFile(path="{self.filepath}")'
+
+    def save(self, data):
+        try:
+            copyfile(self.filepath, self.backup)
+        except Exception:
+            print("warning - geen datafile")
+        try:
+            with open(self.filepath, "w") as file:
+                json.dump(data, file, indent=2)
+        except Exception:
+            return False
+        return True
+
+    def load(self):
+        data = {}
+        for file in [self.filepath, self.backup]:
+            try:
+                if path.isfile(file):
+                    with open(file, "r") as json_file:
+                        data = json.load(json_file)
+            except Exception:
+                continue
+            return data
+
+    def get(self, key: str = None):
+        data = self.load()
+        if not key:
+            return data
+        return data[key] if key in data else {}
+
+
+def getConfigDir():
+    abspath = path.abspath(__file__)
+    dname = path.dirname(abspath)
+    return dname

zermelo_api_vogk-0.2.16/app/zermelo_api/src/credentials.py

@@ -0,0 +1,26 @@
+from .config import getConfig
+from .logger import makeLogger, INFO, DEBUG
+
+logger = makeLogger("creds", INFO)
+
+
+class Credentials:
+    def __init__(self):
+        self.file = getConfig("creds")
+        self.token = ""
+        self.load()
+
+    def load(self):
+        self.token = ""
+        try:
+            data = self.file.load()
+            self.token = data["token"]
+        except Exception as e:
+            logger.trace()
+        finally:
+            logger.debug(f"token: {self.token}")
+            return True if self.token else False
+
+    def settoken(self, token):
+        self.file.save({"token": token})
+        self.token = token

zermelo_api_vogk-0.2.16/app/zermelo_api/src/groepen.py

@@ -0,0 +1,35 @@
+from .zermelo_api import ZermeloCollection, zermelo
+from .logger import makeLogger
+from dataclasses import dataclass, InitVar
+
+logger = makeLogger("GROEPEN")
+
+
+@dataclass
+class Groep:
+    id: int
+    isMainGroup: bool
+    isMentorGroup: bool
+    departmentOfBranch: int
+    name: str
+    extendedName: str
+
+
+@dataclass
+class Groepen(ZermeloCollection, list[Groep]):
+    schoolinschoolyear: InitVar
+
+    def __post_init__(self, schoolinschoolyear: int):
+        query = f"groupindepartments?schoolInSchoolYear={schoolinschoolyear}"
+        self.load_collection(query, Groep)
+
+    def get_department_groups(
+        self, departmentOfBranch: int, maingroup: bool = False
+    ) -> list[Groep]:
+        # returns all groups (if it is/isnt stamklas (maingroup))
+        return [
+            groep
+            for groep in self
+            if groep.departmentOfBranch == departmentOfBranch
+            and groep.isMainGroup == maingroup
+        ]

zermelo_api_vogk-0.2.16/app/zermelo_api/src/leerjaren.py

@@ -0,0 +1,48 @@
+from .zermelo_api import ZermeloCollection
+from .logger import makeLogger
+from dataclasses import dataclass, InitVar
+
+# Leerjaar is a rough dutch translation of department in Zermelo
+
+logger = makeLogger("Leerjaren")
+
+
+def getLeerjaarNaam(string):
+    names = {"LG1": "klas 1", "LG2": "klas 2", "LG3": "klas 3"}
+    for name, result in names.items():
+        if name in string:
+            return result
+    else:
+        return string
+
+
+@dataclass
+class Leerjaar:
+    id: int
+    code: str
+    yearOfEducation: int
+    branchOfSchool: int
+    teacherTeams: list[int]
+    mainGroupAuthority: str
+    educationType: str
+    weekTimeTable: int
+    teachingLevel: str
+    educations: list[int]
+    schoolInSchoolYear: int
+    branchOfSchoolCode: str
+    schoolInSchoolYearName: str
+    profiles: list[int]
+    schoolInSchoolYearId: int
+    name: str = ""
+
+    def __post_init__(self):
+        self.name = getLeerjaarNaam(self.code.upper())
+
+
+@dataclass
+class Leerjaren(ZermeloCollection, list[Leerjaar]):
+    schoolinschoolyear: InitVar
+
+    def __post_init__(self, schoolinschoolyear: int):
+        query = f"departmentsofbranches?schoolInSchoolYear={schoolinschoolyear}"
+        self.load_collection(query, Leerjaar)