Version 0.6: Added PlanetTerp and cleaned up the code

Nazchanel · Nazchanel · commit ee9e1f34c35e · 2025-02-18T16:54:05.000-05:00
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "umd-api" 
-version = "0.5.2"
+version = "0.6"
 description = "A package for accessing the UMD API in Python"
 readme = "README.md"
 authors = [
diff --git a/umd_api/__init__.py b/umd_api/__init__.py
@@ -1,6 +1,14 @@
-from .base_api import _BaseAPI
-from .bus import Bus        
-from .courses import Courses 
-from .majors import Majors   
-from .map import Map         
-from .professors import Professors 
+from .general.base_api import _BaseAPI
+from .general.bus import Bus        
+from .general.courses import Courses 
+from .general.majors import Majors   
+from .general.map import Map         
+from .general.professors import Professors 
+
+from .planet_terp.base_api import _BaseAPI
+from .planet_terp.courses import Courses
+from .planet_terp.professors import Professors
+from .planet_terp.grades import Grades
+from .planet_terp.search import Search
+
+__all__ = ["Bus", "Courses", "Majors", "Map", "Professors", "Grades", "Search"]
diff --git a/umd_api/general/__init__.py b/umd_api/general/__init__.py
@@ -0,0 +1,8 @@
+from .base_api import _BaseAPI
+from .bus import Bus        
+from .courses import Courses 
+from .majors import Majors   
+from .map import Map         
+from .professors import Professors 
+
+__all__ = ["Bus", "Courses", "Majors", "Map", "Professors"]
diff --git a/umd_api/general/base_api.py b/umd_api/general/base_api.py
@@ -7,6 +7,7 @@ class _BaseAPI:
     def _make_request(self, endpoint, **kwargs):
         params = self._extract_params(**kwargs)
 
+        print(f'{self.__BASE_URL}/{endpoint}')
         try:
             response = requests.get(f'{self.__BASE_URL}/{endpoint}', params=params)
             response.raise_for_status() 
diff --git a/umd_api/general/bus.py b/umd_api/general/bus.py
@@ -38,15 +38,23 @@ def list_stops(self):
         return self._make_request(self._ENDPOINT_STOPS)
 
    
-    def get_specific_stops(self, stop_ids):
+    def get_specific_stops(self, stop_ids : list):
 
         """
 
         Get data for one or more stops
 
         """
 
-        return self._make_request(f'{self._ENDPOINT_STOPS}/{stop_ids}')
+        # Formatting
+        stop_ids_str = ""
+
+        for i in stop_ids:
+            stop_ids_str += "stop_id="
+            stop_ids_str += i
+            stop_ids_str += "&"
+
+        return self._make_request(f'{self._ENDPOINT_STOPS}?{stop_ids_str}')
 
     def current_bus_locations_by_route(self, route_id):
 
diff --git a/umd_api/general/courses.py b/umd_api/general/courses.py
@@ -1,6 +1,6 @@
 from .base_api import _BaseAPI
 
-class Courses(BaseAPI):
+class Courses(_BaseAPI):
     
     _ENDPOINT_COURSES = 'courses'
     _ENDPOINT_MINIFIED_COURSES = 'courses/list'
@@ -15,7 +15,7 @@ def list_courses(self, sort=None, page=None, per_page=None, semester=None, credi
         List all courses with optional filters.
         
         """
-        return self.make_request(self._ENDPOINT_COURSES, sort, page, per_page, semester, credits, dept_id, gen_ed)
+        return self._make_request(self._ENDPOINT_COURSES, sort=sort, page=page, per_page=per_page, semester=semester, credits=credits, dept_id=dept_id, gen_ed=gen_ed)
 
     def list_minified_courses(self, sort=None, page=None, per_page=None, semester=None):
 
@@ -25,7 +25,7 @@ def list_minified_courses(self, sort=None, page=None, per_page=None, semester=No
 
         """
         
-        return self.make_request(self._ENDPOINT_COURSES, sort, page, per_page, semester)
+        return self._make_request(self._ENDPOINT_COURSES, sort=sort, page=page, per_page=per_page, semester=semester)
 
     def list_sections(self, sort=None, page=None, per_page=None, course_id=None, seats=None, open_seats=None, waitlist=None, semester=None):
 
@@ -35,17 +35,17 @@ def list_sections(self, sort=None, page=None, per_page=None, course_id=None, sea
         
         """
         
-        return self.make_request(self._ENDPOINT_SECTIONS, sort, page, per_page, course_id, seats, open_seats, waitlist, semester)
+        return self._make_request(self._ENDPOINT_SECTIONS, sort=sort, page=page, per_page=per_page, course_id=course_id, seats=seats, open_seats=open_seats, waitlis=waitlist, semester=semester)
 
-    def view_specific_sections(self, section_ids, semester=None):
+    def view_specific_sections(self, section_ids : list, semester=None):
         
         """
         
         View specific sections by section IDs.
         
         """
         
-        return self.make_request(f'{self._ENDPOINT_SECTIONS}/{section_ids}', semester)
+        return self._make_request(f'{self._ENDPOINT_SECTIONS}/{section_ids}', semester=semester)
 
     def view_specific_courses(self, course_ids, semester=None):
         
@@ -55,7 +55,7 @@ def view_specific_courses(self, course_ids, semester=None):
         
         """
         
-        return self.make_request(f'{self._ENDPOINT_COURSES}/{course_ids}', semester)
+        return self._make_request(f'{self._ENDPOINT_COURSES}/{course_ids}', semester=semester)
         
     def view_sections_for_course(self, course_ids, semester=None):
         
@@ -65,7 +65,7 @@ def view_sections_for_course(self, course_ids, semester=None):
         
         """
         
-        return self.make_request(f'{self._ENDPOINT_COURSES}/{course_ids}/sections', semester)
+        return self._make_request(f'{self._ENDPOINT_COURSES}/{course_ids}/sections', semester=semester)
 
     def view_specific_sections_for_course(self, course_ids, section_ids):
         
@@ -75,7 +75,7 @@ def view_specific_sections_for_course(self, course_ids, section_ids):
         
         """
         
-        return self.make_request(f'{self._ENDPOINT_COURSES}/{course_ids}/sections/{section_ids}')
+        return self._make_request(f'{self._ENDPOINT_COURSES}/{course_ids}/sections/{section_ids}')
 
     def list_semesters(self):
         
@@ -85,7 +85,7 @@ def list_semesters(self):
         
         """
         
-        return self.make_request(self._ENDPOINT_SEMESTERS)
+        return self._make_request(self._ENDPOINT_SEMESTERS)
 
     def list_departments(self):
         
@@ -95,4 +95,4 @@ def list_departments(self):
         
         """
         
-        return self.make_request(self._ENDPOINT_DEPARTMENTS)
+        return self._make_request(self._ENDPOINT_DEPARTMENTS)
diff --git a/umd_api/general/majors.py b/umd_api/general/majors.py
diff --git a/umd_api/general/map.py b/umd_api/general/map.py
diff --git a/umd_api/general/professors.py b/umd_api/general/professors.py
@@ -8,4 +8,4 @@ def list_professors(self, name=None, course_id=None):
         Returns list of all professors
         
         """
-        return self._make_request('professors', name, course_id)
+        return self._make_request('professors', name=name, course_id=course_id)
diff --git a/umd_api/planet_terp/__init__.py b/umd_api/planet_terp/__init__.py
@@ -0,0 +1,7 @@
+from .base_api import _BaseAPI
+from .grades import Grades
+from .courses import Courses
+from .professors import Professors
+from .search import Search
+
+__all__ = ["Grades", "Courses", "Professors", "Search"]
diff --git a/umd_api/planet_terp/base_api.py b/umd_api/planet_terp/base_api.py
@@ -0,0 +1,36 @@
+import requests
+
+class _BaseAPI:
+    
+    _BASE_URL = 'https://planetterp.com/api/v1'
+
+    def _make_request(self, endpoint, **kwargs):
+        params = self._extract_params(**kwargs)
+
+        try:
+            response = requests.get(f'{self._BASE_URL}/{endpoint}', params=params)
+            response.raise_for_status() 
+            return response.json()
+        except requests.HTTPError as http_err:
+            self._handle_error(http_err, response)
+        except requests.RequestException as err:
+            print(f"An error occurred: {err}")
+        except ValueError:
+            print("Error: Received a non-JSON response.")
+
+    def _extract_params(self, **kwargs):
+        return {k: v for k, v in kwargs.items() if v is not None}
+
+    def _handle_error(self, http_err, response):
+        """Handle HTTP error responses."""
+        try:
+            error_info = response.json()
+            error_code = error_info.get("error_code", "Unknown error")
+            message = error_info.get("message", "No message provided")
+            docs = error_info.get("docs", "No documentation available")
+
+            print(f"HTTP Error Code: {error_code}")
+            print(f"Message: {message}")
+            print(f"Documentation: {docs}")
+        except ValueError:
+            print(f"Received an error response, but couldn't parse JSON: {response.text}")
diff --git a/umd_api/planet_terp/courses.py b/umd_api/planet_terp/courses.py
@@ -0,0 +1,25 @@
+from .base_api import _BaseAPI
+
+class Courses(_BaseAPI):
+    _ENDPOINT_COURSE = 'course'
+    _ENDPOINT_COURSES = 'courses'
+
+    def get_course(self, name, reviews=None):
+
+        """
+
+        Gets the specified courses
+
+        """
+
+        return self._make_request(self._ENDPOINT_COURSE, name=name, reviews=reviews)
+
+    def get_courses(self, department=None, reviews=None, limit=None, offset=None):
+        
+        """
+
+        Get all courses, in alphabetical order
+
+        """
+        
+        return self._make_request(self._ENDPOINT_COURSES, department=department, reviews=reviews, limit=limit, offset=offset)
diff --git a/umd_api/planet_terp/grades.py b/umd_api/planet_terp/grades.py
@@ -0,0 +1,15 @@
+from .base_api import _BaseAPI
+
+class Grades(_BaseAPI):
+    _ENDPOINT_GRADES = "grades"
+
+    def get_grades(self, course=None, professor=None, semester=None, section=None):
+
+        """
+
+        Get grades for a course, a professor, or both. If by course, returns all of the grades available by section.
+
+        """
+
+        return self._make_request(self._ENDPOINT_GRADES, course=course, professor=professor, semester=semester, section=section)
+
diff --git a/umd_api/planet_terp/professors.py b/umd_api/planet_terp/professors.py
@@ -0,0 +1,25 @@
+from .base_api import _BaseAPI
+
+class Professors(_BaseAPI):
+    _ENDPOINT_PROFESSOR = 'professor'
+    _ENDPOINT_PROFESSORS = 'professors'
+
+    def get_professor(self, name, reviews=None):
+
+        """
+
+        Get the specified professor.
+
+        """
+
+        return self._make_request(self._ENDPOINT_PROFESSOR, name, reviews)
+    
+    def get_all_professors(self, type=None, reviews=None, limit=None, offset=None):
+        
+        """
+
+        Get all professors, in alphabetical order
+
+        """
+        
+        return self._make_request(self._ENDPOINT_PROFESSORS, type=type, reviews=reviews, limit=limit, offset=offset)
diff --git a/umd_api/planet_terp/search.py b/umd_api/planet_terp/search.py
@@ -0,0 +1,15 @@
+from .base_api import _BaseAPI
+
+class Search(_BaseAPI):
+    _ENDPOINT_SEARCH = 'search'
+
+    def search(self, query, limit=None, offset=None):
+
+        """
+
+        Search both professors and courses with a query string. This will match professors and courses which have the query string as a substring of their name.
+    
+        """
+
+        self._make_request(endpoint='search', query=query, limit=limit, offset=offset)
+        
