esprit-py 0.1.0__tar.gz → 0.2.1__tar.gz

{esprit-py-0.1.0 → esprit-py-0.2.1}/PKG-INFO

@@ -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>
@@ -14,7 +14,19 @@ Classifier: Operating System :: Microsoft :: Windows
 Description-Content-Type: text/markdown
 
 
-# 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/README.md

@@ -0,0 +1,16 @@
+# <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/esprit/__init__.py

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

esprit-py-0.1.0/esprit/absence_scrape.py → esprit-py-0.2.1/esprit/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-py-0.1.0 → esprit-py-0.2.1}/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-py-0.1.0 → esprit-py-0.2.1}/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-py-0.1.0 → esprit-py-0.2.1}/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-py-0.1.0/esprit/grade_scrape.py → esprit-py-0.2.1/esprit/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-py-0.1.0/esprit/time_schedule_scrape.py → esprit-py-0.2.1/esprit/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 → esprit-py-0.2.1}/esprit_py.egg-info/PKG-INFO

@@ -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>
@@ -14,7 +14,19 @@ Classifier: Operating System :: Microsoft :: Windows
 Description-Content-Type: text/markdown
 
 
-# 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.1.0 → esprit-py-0.2.1}/esprit_py.egg-info/SOURCES.txt

@@ -1,12 +1,12 @@
 README.md
 setup.py
 esprit/__init__.py
-esprit/absence_scrape.py
+esprit/absence.py
 esprit/auth.py
 esprit/credit.py
 esprit/esprit.py
-esprit/grade_scrape.py
-esprit/time_schedule_scrape.py
+esprit/grade.py
+esprit/time_schedule.py
 esprit_py.egg-info/PKG-INFO
 esprit_py.egg-info/SOURCES.txt
 esprit_py.egg-info/dependency_links.txt

{esprit-py-0.1.0 → esprit-py-0.2.1}/setup.py

@@ -8,10 +8,10 @@ with codecs.open(os.path.join(here, "README.md"), encoding="utf-8") as fh:
     long_description = "\n" + fh.read()
 
 # Read requirements.txt
-with open('requirements.txt') as f:
+with open(os.path.join(here, 'requirements.txt')) as f:
     requirements = f.read().splitlines()
 
-VERSION = '0.1.0'
+VERSION = '0.2.1'
 DESCRIPTION = ' A Python library for interacting with data from esprit-tn.com'
 LONG_DESCRIPTION = 'esprit-py, provides a set of tools for interacting with data from the Esprit website. It includes functionalities for scraping grades, absences, time schedules, and credits. It also provides the ability to download files and get class week schedules.'
 
@@ -25,7 +25,7 @@ setup(
     long_description_content_type="text/markdown",
     long_description=long_description,
     packages=find_packages(),
-    install_requires=requirements,  # Use requirements from requirements.txt
+    install_requires=requirements,
     keywords=['python', 'api'],
     classifiers=[
         "Development Status :: 1 - Planning",
@@ -34,5 +34,15 @@ setup(
         "Operating System :: Unix",
         "Operating System :: MacOS :: MacOS X",
         "Operating System :: Microsoft :: Windows",
-    ]
+    ],
+    package_data={"": ["requirements.txt"]},
 )
+
+'''
+python setup.py sdist bdist_wheel
+twine check dist/*
+twine upload dist/*
+-
+username: __token__
+password: pypi-...
+'''

esprit-py-0.1.0/README.md

@@ -1,4 +0,0 @@
-# esprit-api
- 
-missing stuff:
-- [ ] download any time table from the esprit website , not only the last one