esprit-py 0.3.1__py3-none-any.whl → 0.3.3__py3-none-any.whl

esprit/auth.py

@@ -6,7 +6,42 @@ from selenium.webdriver.chrome.options import Options
 
 
 class Auth:
+    """
+    A class used to represent an Authentication process
+
+    ...
+
+    Attributes
+    ----------
+    login_url : str
+        a string representing the login URL
+    debug : bool
+        a boolean indicating if debug mode is on
+    driver : WebDriver
+        a WebDriver object to interact with the browser
+
+    Methods
+    -------
+    login(id, password)
+        Logs in to the website using the provided id and password
+    """
+
     def __init__(self, driver_path=None, driver=None, debug=False, headless=True):
+        """
+        Constructs all the necessary attributes for the Auth object.
+
+        Parameters
+        ----------
+            driver_path : str, optional
+                Path to the WebDriver executable (default is None)
+            driver : WebDriver, optional
+                Existing WebDriver instance (default is None)
+            debug : bool, optional
+                Debug mode flag (default is False)
+            headless : bool, optional
+                Headless mode flag for the browser (default is True)
+        """
+
         self.login_url = "https://esprit-tn.com/esponline/online/default.aspx"
         self.debug = debug
 
@@ -19,6 +54,22 @@ class Auth:
             executable_path=driver_path, options=chrome_options)
 
     def login(self, id, password):
+        """
+        Logs in to the website using the provided id and password.
+
+        Parameters
+        ----------
+            id : str
+                User's id
+            password : str
+                User's password
+
+        Returns
+        -------
+        list
+            List of cookies if login is successful, None otherwise
+        """
+
         self.driver.get(self.login_url)
 
         # Fill in the ID

esprit/esprit.py

@@ -7,10 +7,9 @@ from .credit import Credit
 
 
 class Esprit:
-    def __init__(self):
+    def __init__(self, driver_path=None, driver=None, debug=False, headless=True):
         self.session = requests.Session()
-        self.auth = Auth()
-        self.grade_scrape = Grade(self.session)
+        self.auth = Auth(driver_path, driver, debug, headless)
         self.grade_scrape = Grade(self.session)
         self.absence_scrape = Absence(self.session)
         self.time_schedule_scrape = TimeSchedule(self.session)
@@ -18,11 +17,15 @@ class Esprit:
 
     def login(self, username, password):
         cookies = self.auth.login(username, password)
-        self.session.cookies.update(cookies)
+        cookies_dict = {cookie['name']: cookie['value'] for cookie in cookies}
+        self.session.cookies.update(cookies_dict)
 
     def get_grades(self):
         return self.grade_scrape.get_grades()
 
+    def calculate_average(self, grades):
+        return self.grade_scrape.calculate_average(grades)
+
     def get_absences(self):
         return self.absence_scrape.get_absences()
 

esprit/grade.py

@@ -1,5 +1,7 @@
 import requests
 from bs4 import BeautifulSoup
+import pandas as pd
+import numpy as np
 
 
 class Grade:
@@ -50,3 +52,39 @@ class Grade:
         grades = [headers] + [[cell.text.strip() for cell in row.find_all('td')]
                               for row in rows[1:]]  # Skip header row
         return grades
+
+    def calculate_average(self, grades):
+        # Convert the list of lists to a DataFrame
+        df = pd.DataFrame(grades[1:], columns=grades[0])
+
+        # Replace empty strings with NaN
+        df.replace('', np.nan, inplace=True)
+
+        # Replace comma with dot and convert to float
+        for col in ['COEF', 'NOTE_CC', 'NOTE_TP', 'NOTE_EXAM']:
+            df[col] = df[col].str.replace(',', '.').astype(float)
+
+        # Calculate the average based on available grades
+
+        def calculate_average(row):
+            if pd.isna(row['NOTE_TP']):
+                if pd.isna(row['NOTE_CC']):
+                    return row['NOTE_EXAM']
+                else:
+                    return row['NOTE_EXAM'] * 0.6 + row['NOTE_CC'] * 0.4
+            elif pd.isna(row['NOTE_CC']):
+                return row['NOTE_EXAM'] * 0.8 + row['NOTE_TP'] * 0.2
+            else:
+                return row['NOTE_EXAM'] * 0.5 + row['NOTE_CC'] * 0.3 + row['NOTE_TP'] * 0.2
+
+        df['MOYENNE'] = df.apply(calculate_average, axis=1)
+
+        # Calculate the total average
+        total_average = (df['MOYENNE'] * df['COEF']).sum() / df['COEF'].sum()
+
+        # Append the total average to the DataFrame
+        df = df._append({'DESIGNATION': 'Moyenne', 'COEF': df['COEF'].sum(
+        ), 'MOYENNE': total_average}, ignore_index=True)
+
+        print(df)
+        return total_average

{esprit_py-0.3.1.dist-info → esprit_py-0.3.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: esprit-py
-Version: 0.3.1
+Version: 0.3.3
 Summary: A Python library for interacting with data from esprit-tn.com
 Home-page: https://github.com/TheLime1/esprit.py
 Author: Lime1 (Aymen Hmani)
@@ -17,92 +17,55 @@ Requires-Dist: requests
 Requires-Dist: beautifulsoup4
 Requires-Dist: PyPDF2
 Requires-Dist: selenium
+Requires-Dist: numpy
+Requires-Dist: pandas
 
 
 # <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
 
-
-
 ## Installation
 
-
-
 ```bash
-
 pip install esprit-py
-
 ```
 
-
+download `chromedriver` from [here](https://googlechromelabs.github.io/chrome-for-testing/#stable)
 
 ## Example
 
-
-
 ```python
-
 from esprit import Esprit
 
-
-
 # Create an Esprit object
-
-esprit = Esprit()
-
-
+esprit = Esprit(
+    driver_path="C:/path/to/chromedriver.exe",)
 
 # Replace with your actual ID and password
-
 id = 'ID'
-
 password = 'PASSWORD'
 
-
-
 # Attempt to log in
-
 if esprit.login(id, password):
-
     print("Login successful.")
-
 else:
-
     print("Login failed.")
 
-
-
 # Get absences
-
 absences = esprit.get_absences()
-
 if absences is not None:
-
     for absence in absences:
-
         print(absence)
-
 else:
-
     print("Failed to get absences.")
 
 ```

esprit_py-0.3.3.dist-info/RECORD

@@ -0,0 +1,12 @@
+esprit/__init__.py,sha256=PnahGRQ5xmA26XMFaj9ImLty9OEmYwnBqLanvGXZwwU,28
+esprit/absence.py,sha256=qOFyK0QmSaWYrz_2RlDFcCom-m6QZLJAzG1dBj3YkbI,1666
+esprit/auth.py,sha256=-jkquqEGZ8I7K61T4QsXHLfDTIwdhbirOrtEmGysbqQ,4034
+esprit/credit.py,sha256=iKy_lTR_iLAkpRkP92l2gAUi4Dh6JvLidxGhuM9YJ68,1747
+esprit/esprit.py,sha256=xjXqkXIGgV5J0DGSwBIM-ihj7123SH7DASzHPL0Fzpg,1680
+esprit/grade.py,sha256=ip30Aavx9mCdwIpziXLENLMaEmaIM6mkC3EXnT0041g,3098
+esprit/time_schedule.py,sha256=sU2gwV9dmIyFhSe0qlxTGg05L7lhLbD0YN0qhMXdNc0,6490
+esprit_py-0.3.3.dist-info/LICENSE,sha256=DOcn7qpE6TsUEcakIsDDKm757jx5YlQ8fXDiED21P_w,1089
+esprit_py-0.3.3.dist-info/METADATA,sha256=TfDmCND5Di6lTJHWIf8-MaalKcTQ0veV3g1gbEaJPnM,1833
+esprit_py-0.3.3.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+esprit_py-0.3.3.dist-info/top_level.txt,sha256=aS9besFTZ4EYTsoBJVf3GaMjQtJLgLaK7WqAxSvGVdQ,7
+esprit_py-0.3.3.dist-info/RECORD,,

esprit_py-0.3.1.dist-info/RECORD

@@ -1,12 +0,0 @@
-esprit/__init__.py,sha256=PnahGRQ5xmA26XMFaj9ImLty9OEmYwnBqLanvGXZwwU,28
-esprit/absence.py,sha256=qOFyK0QmSaWYrz_2RlDFcCom-m6QZLJAzG1dBj3YkbI,1666
-esprit/auth.py,sha256=Yyu0W4-vGafb9mwWknpYN_nzSbbRZhlly6ZyliZCErQ,2660
-esprit/credit.py,sha256=iKy_lTR_iLAkpRkP92l2gAUi4Dh6JvLidxGhuM9YJ68,1747
-esprit/esprit.py,sha256=mCnFVZUIDKlK2v4nv7I9tFM84-MHBsyyv51aXyc5T7w,1445
-esprit/grade.py,sha256=EAgYvA-490Jj9TeUCIlSQeW4aVu2gcmfujNxDG-91Fw,1648
-esprit/time_schedule.py,sha256=sU2gwV9dmIyFhSe0qlxTGg05L7lhLbD0YN0qhMXdNc0,6490
-esprit_py-0.3.1.dist-info/LICENSE,sha256=DOcn7qpE6TsUEcakIsDDKm757jx5YlQ8fXDiED21P_w,1089
-esprit_py-0.3.1.dist-info/METADATA,sha256=ayAQO4PiuQ-i2i5046vt74JqX5m9HrrH_2DALC3DhAM,1722
-esprit_py-0.3.1.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-esprit_py-0.3.1.dist-info/top_level.txt,sha256=aS9besFTZ4EYTsoBJVf3GaMjQtJLgLaK7WqAxSvGVdQ,7
-esprit_py-0.3.1.dist-info/RECORD,,