esprit-py 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

esprit/__init__.py

@@ -0,0 +1 @@
+from .esprit import Esprit

esprit/{absence_scrape.py → absence.py}

@@ -3,11 +3,39 @@ from bs4 import BeautifulSoup
 
 
 class Absence:
+    """
+    A class used to represent an Absence.
+
+    ...
+
+    Attributes
+    ----------
+    url : str
+        a formatted string that represents the URL of the absence page
+    session : requests.Session
+        a Session object from the requests library
+
+    Methods
+    -------
+    get_absences():
+        Returns a list of absences for the student.
+    """
+
     def __init__(self, session):
         self.url = "https://esprit-tn.com/ESPOnline/Etudiants/absenceetud.aspx"
         self.session = session
 
     def get_absences(self):
+        """
+        Returns a list of absences for the student.
+
+        Returns
+        -------
+        list
+            a list of absences, each represented as a list of strings. The first list is the headers.
+            Returns None if the page does not contain the expected text.
+        """
+
         response = self.session.get(self.url)
         soup = BeautifulSoup(response.text, 'html.parser')
 

esprit/auth.py

@@ -2,11 +2,45 @@ import requests
 
 
 class Auth:
+    """
+    A class used to represent an Authentication.
+
+    ...
+
+    Attributes
+    ----------
+    login_url : str
+        a formatted string that represents the login URL
+    session : requests.Session
+        a Session object from the requests library
+
+    Methods
+    -------
+    login(id: str, password: str):
+        Logs in to the website using the provided id and password.
+    """
+
     def __init__(self, session=None):
         self.login_url = "https://esprit-tn.com/esponline/online/default.aspx"
         self.session = session if session else requests.session()
 
     def login(self, id, password):
+        """
+        Logs in to the website using the provided id and password.
+
+        Parameters
+        ----------
+            id : str
+                the id to use for login
+            password : str
+                the password to use for login
+
+        Returns
+        -------
+        requests.Session
+            the Session object used for the login. This can be used for subsequent requests.
+            Returns None if the login failed.
+        """
         id_payload = {
             '__EVENTTARGET': '',
             '__EVENTARGUMENT': '',

esprit/credit.py

@@ -3,11 +3,38 @@ from bs4 import BeautifulSoup
 
 
 class Credit:
+    """
+    A class used to represent a Credit.
+
+    ...
+
+    Attributes
+    ----------
+    url : str
+        a formatted string that represents the URL of the credit page
+    session : requests.Session
+        a Session object from the requests library
+
+    Methods
+    -------
+    get_credits():
+        Returns a list of credits for the student.
+    """
+
     def __init__(self, session):
         self.url = "https://esprit-tn.com/ESPOnline/Etudiants/Historique_Cr%C3%A9dit.aspx"
         self.session = session
 
     def get_credits(self):
+        """
+        Returns a list of credits for the student.
+
+        Returns
+        -------
+        list
+            a list of credits, each represented as a list of strings. The first list is the headers.
+            Returns None if the page does not contain the expected text.
+        """
         response = self.session.get(self.url)
         soup = BeautifulSoup(response.text, 'html.parser')
 

esprit/esprit.py

@@ -1,8 +1,8 @@
 import requests
 from auth import Auth
-from grade_scrape import Grade
-from absence_scrape import Absence
-from time_schedule_scrape import TimeSchedule
+from grade import Grade
+from absence import Absence
+from time_schedule import TimeSchedule
 from credit import Credit
 
 

esprit/{grade_scrape.py → grade.py}

@@ -3,11 +3,38 @@ from bs4 import BeautifulSoup
 
 
 class Grade:
+    """
+    A class used to represent a Grade.
+
+    ...
+
+    Attributes
+    ----------
+    url : str
+        a formatted string that represents the URL of the grade page
+    session : requests.Session
+        a Session object from the requests library
+
+    Methods
+    -------
+    get_grades():
+        Returns a list of grades for the student.
+    """
+
     def __init__(self, session):
         self.url = "https://esprit-tn.com/ESPOnline/Etudiants/Resultat2021.aspx"
         self.session = session
 
     def get_grades(self):
+        """
+        Returns a list of grades for the student.
+
+        Returns
+        -------
+        list
+            a list of grades, each represented as a list of strings. The first list is the headers.
+            Returns None if the page does not contain the expected text.
+        """
         response = self.session.get(self.url)
         soup = BeautifulSoup(response.text, 'html.parser')
 

esprit/{time_schedule_scrape.py → time_schedule.py}

@@ -7,11 +7,44 @@ from PyPDF2 import PdfReader, PdfWriter
 
 
 class TimeSchedule:
+    """
+    A class used to represent a Time Schedule.
+
+    ...
+
+    Attributes
+    ----------
+    url : str
+        a formatted string that represents the URL of the time schedule page
+    session : requests.Session
+        a Session object from the requests library
+
+    Methods
+    -------
+    get_table_schedules():
+        Returns a list of time schedules for the student.
+    get_last_week_schedule():
+        Returns the most recent weekly schedule.
+    download_files(schedule: list):
+        Downloads the files associated with a given schedule.
+    get_class_week_schedule(file_path: str, class_name: str):
+        Extracts the weekly schedule for a specific class from a given file.
+    """
+
     def __init__(self, session):
         self.url = "https://esprit-tn.com/ESPOnline/Etudiants/Emplois.aspx"
         self.session = session
 
     def get_table_schedules(self):
+        """
+        Returns a list of time schedules for the student.
+
+        Returns
+        -------
+        list
+            a list of time schedules, each represented as a list of strings.
+            Returns None if the page does not contain the expected text.
+        """
         response = self.session.get(self.url)
         soup = BeautifulSoup(response.text, 'html.parser')
 
@@ -36,6 +69,15 @@ class TimeSchedule:
         return time_schedules
 
     def get_last_week_schedule(self):
+        """
+        Returns the most recent weekly schedule.
+
+        Returns
+        -------
+        list
+            the most recent weekly schedule, represented as a list of strings.
+            Returns None if no schedules are found.
+        """
         time_schedules = self.get_table_schedules()
         if time_schedules is None:
             return None
@@ -59,6 +101,19 @@ class TimeSchedule:
         return dates_and_schedules[-1][1] if dates_and_schedules else None
 
     def download_files(self, schedule):
+        """
+        Downloads the files associated with a given schedule.
+
+        Parameters
+        ----------
+            schedule : list
+                the schedule to download files for, represented as a list of strings
+
+        Returns
+        -------
+        str
+            the path to the downloaded file
+        """
         response = self.session.get(self.url)
         soup = BeautifulSoup(response.text, 'html.parser')
 
@@ -87,6 +142,21 @@ class TimeSchedule:
         return file_path
 
     def get_class_week_schedule(self, file_path, class_name):
+        """
+        Extracts the weekly schedule for a specific class from a given file.
+
+        Parameters
+        ----------
+            file_path : str
+                the path to the file to extract the schedule from
+            class_name : str
+                the name of the class to extract the schedule for
+
+        Returns
+        -------
+        str
+            the path to the extracted schedule, or None if the class is not found in the file
+        """
         # Open the existing PDF
         with open(file_path, "rb") as file:
             reader = PdfReader(file)

{esprit_py-0.1.0.dist-info → esprit_py-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: esprit-py
-Version: 0.1.0
+Version: 0.2.1
 Summary: A Python library for interacting with data from esprit-tn.com
 Author: Lime1 (Aymen Hmani)
 Author-email: <everpadd4@gmail.com>
@@ -17,7 +17,19 @@ Requires-Dist: beautifulsoup4
 Requires-Dist: PyPDF2
 
 
-# esprit-api
- 
+# <img src="https://esprit.tn/favicon.ico" width="28px" /> esprit-py
+
+> [!NOTE]
+> Please note that this library is not an official API provided by Esprit and is intended for educational and personal use only.
+
+## Features
+
+- Get your exact timetable pdf not 300 pages pdf
+- Get your grades
+- Get your absences
+- Get your credits
+
 missing stuff:
 - [ ] download any time table from the esprit website , not only the last one
+- [ ] post stuff (reclamation,document stage,teacher evaluation) *dangereous area tbh*
+

esprit_py-0.2.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+esprit/__init__.py,sha256=PnahGRQ5xmA26XMFaj9ImLty9OEmYwnBqLanvGXZwwU,28
+esprit/absence.py,sha256=qOFyK0QmSaWYrz_2RlDFcCom-m6QZLJAzG1dBj3YkbI,1666
+esprit/auth.py,sha256=2N7B5QV9NiDTDvBbiqzHAOsdOSX53XXSGa0mr9SUIQI,4021
+esprit/credit.py,sha256=iKy_lTR_iLAkpRkP92l2gAUi4Dh6JvLidxGhuM9YJ68,1747
+esprit/esprit.py,sha256=CSDo_fgcs8cavGYAnrdONqS-xtIKVbCkuTBpQ_5zg1M,1347
+esprit/grade.py,sha256=EAgYvA-490Jj9TeUCIlSQeW4aVu2gcmfujNxDG-91Fw,1648
+esprit/time_schedule.py,sha256=KcT0XMpY3lJyT9v9pJ3xrPEBqPRZRi4kz0jhrozek2M,6220
+esprit_py-0.2.1.dist-info/METADATA,sha256=jAXzWxnhRmwkPaomAt25ZQWSiZ4SRigg1vKwM2uj1Lg,1151
+esprit_py-0.2.1.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+esprit_py-0.2.1.dist-info/top_level.txt,sha256=aS9besFTZ4EYTsoBJVf3GaMjQtJLgLaK7WqAxSvGVdQ,7
+esprit_py-0.2.1.dist-info/RECORD,,

esprit_py-0.1.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-esprit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-esprit/absence_scrape.py,sha256=y7v9JS4ZB3k97KBuM5e2VlesBS8M-siqq0KnlVf1QkA,977
-esprit/auth.py,sha256=He2c7XF8VlzKjQ4CsuTtZfarNsmjPwJszoNfVV5Cgm4,3134
-esprit/credit.py,sha256=isQV2YJQyTtEumfok3sATpiFzsxYM11s6--UNsFkNZQ,1067
-esprit/esprit.py,sha256=UuLK3NRGYBYkjQTIPkQjGJx8UWb5m7hRo3Xk-LKNgVo,1368
-esprit/grade_scrape.py,sha256=k5LjhX2xeoutWpt0HoVM-uwAbRoVE0BSH49uyaxKAhg,974
-esprit/time_schedule_scrape.py,sha256=fCo3HD2xLCPKmibVVEqK16m4oDiWKtHku4MyZZBeSk8,4124
-esprit_py-0.1.0.dist-info/METADATA,sha256=F-TACsJU92OvIln0Vp5gOImT8rHx9Yd1Y5c0-dyNTOg,736
-esprit_py-0.1.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-esprit_py-0.1.0.dist-info/top_level.txt,sha256=aS9besFTZ4EYTsoBJVf3GaMjQtJLgLaK7WqAxSvGVdQ,7
-esprit_py-0.1.0.dist-info/RECORD,,