Minor refactor

pesuacademy/models/__init__.py

@@ -9,3 +9,4 @@
     AddressDetails,
     QualifyingExamination,
 )
+from .professor import Professor

pesuacademy/models/staff.py → pesuacademy/models/professor.py

@@ -1,18 +1,18 @@
 from typing import Optional
 
 
-class Staff:
+class Professor:
     def __init__(
-        self,
-        name: str,
-        designation: str,
-        campus: str,
-        department: str,
-        mail: str,
-        domains: Optional[list] = None,
-        responsibilities: Optional[list] = None,
-        education: Optional[list] = None,
-        experience: Optional[list] = None,
+            self,
+            name: str,
+            designation: str,
+            campus: str,
+            department: str,
+            email: str,
+            domains: Optional[list] = None,
+            responsibilities: Optional[list] = None,
+            education: Optional[list] = None,
+            experience: Optional[list] = None,
     ):
         self.name = name
         self.designation = designation
@@ -21,7 +21,7 @@ def __init__(
         self.department = department
         self.campus = campus
         self.domains = domains
-        self.mail = mail
+        self.email = email
         self.responsibilities = responsibilities
 
     def __str__(self):

pesuacademy/pages/__init__.py

@@ -1,3 +1,4 @@
 from .attendance import AttendancePageHandler
 from .courses import CoursesPageHandler
 from .profile import ProfilePageHandler
+from .faculty import FacultyPageHandler

pesuacademy/pages/staff.py → pesuacademy/pages/faculty.py

@@ -1,12 +1,12 @@
-from requests_html import HTMLSession
-import requests
 from bs4 import BeautifulSoup
-from ..models.staff import Staff
+import requests_html
+from typing import Optional
+from pesuacademy.models.professor import Professor
 
 
-class StaffPageHandler:
+class FacultyPageHandler:
     @staticmethod
-    def get_staff_details() -> list:
+    def get_staff_details() -> list[Professor]:
         try:
             base_url = "https://staff.pes.edu/atoz/"
             session = HTMLSession()
@@ -127,23 +127,28 @@ def get_details_from_url(url, session):
         if responsibilities_div is not None:
             p_tags = responsibilities_div.find_all("p")
             responsibilities = [p.text for p in p_tags]
-        Pesu_Staff = Staff(
+        Pesu_Staff = Professor(
             name=name,
             designation=designation,
             education=professor_education,
             experience=professor_experience,
             department=department,
             campus=campus,
             domains=domains,
-            mail=email,
+            email=email,
             responsibilities=responsibilities,
         )
         return Pesu_Staff
 
-    @staticmethod
-    def get_staff(department=None, designation=None):
-        all_staff = StaffPageHandler.get_staff_details()
-        print(all_staff)
+    def get_page(
+        self,
+        session: requests_html.HTMLSession,
+        department: Optional[str] = None,
+        designation: Optional[str] = None,
+        campus: Optional[str] = None,
+    ) -> list[Professor]:
+        # TODO: Refactor this to use specific URLs: https://staff.pes.edu/rr/atoz/computer-science/
+        all_staff = self.get_staff_details()
         filtered_staff = all_staff
 
         if department:
@@ -159,14 +164,3 @@ def get_staff(department=None, designation=None):
             ]
 
         return filtered_staff
-
-
-# def main():
-#     #usage
-#     cse_staff = StaffPageHandler.get_staff(department="Computer Science")
-#     for staff_member in cse_staff:
-#         print(staff_member.name)
-
-
-# if __name__ == "__main__":
-#     main()

pesuacademy/pesuacademy.py

@@ -6,7 +6,7 @@
 from pesuacademy import util
 from pesuacademy.util.page import PageHandler
 from .exceptions import CSRFTokenError, AuthenticationError
-from .models import Profile, ClassAndSectionInfo, Course
+from .models import Profile, ClassAndSectionInfo, Course, Professor
 
 
 class PESUAcademy:
@@ -155,3 +155,19 @@ def attendance(self, semester: Optional[int] = None) -> dict[int, list[Course]]:
             raise AuthenticationError("You need to authenticate first.")
         attendance_info = self.page_handler.get_attendance(semester)
         return attendance_info
+
+    def faculty(
+        self,
+        department: Optional[str] = None,
+        designation: Optional[str] = None,
+        campus: Optional[str] = None,
+    ) -> list[Professor]:
+        """
+        Get the faculty information of the university.
+
+        :param department: The department name.
+        :param designation: The designation of the faculty.
+        :return: The faculty information.
+        """
+        faculty_info = self.page_handler.get_faculty(department, designation, campus)
+        return faculty_info

pesuacademy/util/page.py

@@ -14,6 +14,7 @@ def __init__(self, session: requests_html.HTMLSession):
         self.course_page_handler = pages.CoursesPageHandler()
         self.attendance_page_handler = pages.AttendancePageHandler()
         self.profile_page_handler = pages.ProfilePageHandler()
+        self.faculty_page_handler = pages.FacultyPageHandler()
 
     def set_semester_id_to_number_mapping(self, csrf_token: str):
         try:
@@ -80,3 +81,13 @@ def get_courses(self, semester: Optional[int] = None):
     def get_attendance(self, semester: Optional[int] = None):
         semester_ids = self.get_semester_ids_from_semester_number(semester)
         return self.attendance_page_handler.get_page(self.__session, semester_ids)
+
+    def get_faculty(
+        self,
+        department: Optional[str] = None,
+        designation: Optional[str] = None,
+        campus: Optional[str] = None,
+    ):
+        return self.faculty_page_handler.get_page(
+            self.__session, department, designation, campus
+        )