PyKubeGrader 0.3.8__py3-none-any.whl → 0.3.10__py3-none-any.whl

{PyKubeGrader-0.3.8.dist-info → PyKubeGrader-0.3.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyKubeGrader
-Version: 0.3.8
+Version: 0.3.10
 Summary: Add a short description here!
 Home-page: https://github.com/pyscaffold/pyscaffold/
 Author: jagar2
@@ -26,6 +26,7 @@ Requires-Dist: ruff
 Requires-Dist: setuptools
 Requires-Dist: sphinx
 Requires-Dist: types-python-dateutil
+Requires-Dist: types-pyyaml
 Requires-Dist: types-requests
 Requires-Dist: types-setuptools
 Provides-Extra: testing

{PyKubeGrader-0.3.8.dist-info → PyKubeGrader-0.3.10.dist-info}/RECORD

@@ -1,25 +1,30 @@
 pykubegrader/__init__.py,sha256=AoAkdfIjDDZGWLlsIRENNq06L9h46kDGBIE8vRmsCfg,311
-pykubegrader/grading_tester.ipynb,sha256=wwT9jyhpR6GGM8r4todaGfrsUxS6JxM0qIqMcDYKM7w,18839
+pykubegrader/grading_tester.ipynb,sha256=D26O0fgIV1aIYDnIJQspu72lOOQfNS_boIx93apjKDQ,20025
 pykubegrader/initialize.py,sha256=Bwu1q18l18FB9lGppvt-L41D5gzr3S8t6zC0_UbrASw,3994
-pykubegrader/telemetry.py,sha256=oFw27YfTLYZvn7iZKh4jzYXjD726MuUoIQ-9twbXxXk,16632
+pykubegrader/telemetry.py,sha256=0Is-LhpVoKcEjmgqEjCfNLCKJVGAmJaQmD2VHF8KI9w,16396
 pykubegrader/utils.py,sha256=jlJklKvRhY3O7Hz2aaU1m0y3p_n9eMAXNnAF7LUEaPY,1275
 pykubegrader/validate.py,sha256=OKnItGyd-L8QPKcsE0KRuwBI_IxKiJzMLJKZiA2j3II,11184
 pykubegrader/build/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-pykubegrader/build/api_notebook_builder.py,sha256=EZG4Ow4YATzOWPPNLkdQEdWt7hkpbaI5ZD1Bf2KEWeY,25622
-pykubegrader/build/build_folder.py,sha256=HDccW597shBhAd-jxvMUPpsiNj2S4DlKRGMDH_6U9nQ,87590
+pykubegrader/build/api_notebook_builder.py,sha256=vSnBEgHglKjNqwwQnsY0VrWhkwc6q5soJuszNfyKz9o,25748
+pykubegrader/build/build_folder.py,sha256=UL5AzApDLRXD0EujHI5nsCbgaYo486SvL4_vYP_HsDE,87645
 pykubegrader/build/clean_folder.py,sha256=8N0KyL4eXRs0DCw-V_2jR9igtFs_mOFMQufdL6tD-38,1323
 pykubegrader/build/collate.py,sha256=cVvF7tf2U3iiH4R_dbghTcieedIx5w3Fyw9L_llInM8,6754
 pykubegrader/build/markdown_questions.py,sha256=cSh8mkHK3hh-etJdgrZu9UQi1WPrKQtofkzLCUp1Z-w,4676
-pykubegrader/grade_reports/get_my_grades_testing.py,sha256=JNgaHK1eMDPxJASrPpIcXxwMYE0kB0r4p5EgD6GICl4,2359
-pykubegrader/grade_reports/grade_reports.py,sha256=n8H_n9jdZRSPn2zlIf-GQt_Y8w91p6M8ZbdVH76Sg5k,2303
+pykubegrader/grade_reports/__grade_reports.py,sha256=n8H_n9jdZRSPn2zlIf-GQt_Y8w91p6M8ZbdVH76Sg5k,2303
+pykubegrader/grade_reports/assignments.py,sha256=Wr5jvTeQ0a7Fl89e6EzXKqjhLrsA6KyObOdrJdN1V0Y,7614
+pykubegrader/grade_reports/class_grade_report.py,sha256=9Uuvy-xoABtjTjv-05VYhmowebgTrgEFSgh1Grws-cQ,5078
+pykubegrader/grade_reports/grade_report.py,sha256=wxgSGjvX9rcE0s9Up2zxPACGv78sJ3TvP8px3bc7t-c,13993
+pykubegrader/grade_reports/grading_config.py,sha256=_Wki6ju6OkqIuwEl-YMpYJcG5Yeu5wid-NEUN5Oxshs,2332
+pykubegrader/grade_reports/test.ipynb,sha256=NkMZHcfBd-uJw3i1Y9ux-epBP5GiVFEhda5wxEbK0cU,808
 pykubegrader/graders/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 pykubegrader/graders/late_assignments.py,sha256=_2-rA5RqO0BWY9WAQA_mbCxxPKTOiJOl-byD2CYWaE0,1393
 pykubegrader/log_parser/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 pykubegrader/log_parser/parse.ipynb,sha256=5e-9dzUbJk2M8kPP55lVeksm86lSY5ocKfWOP2RSWH0,11921
 pykubegrader/log_parser/parse.py,sha256=dXzTEOTI6VTRNoHFDAjg6hZUhvB3kHtMb10_KW3NPrw,7641
-pykubegrader/submit/submit_assignment.py,sha256=EJkdADfihojJxAPZEmEiEEg1Vo-FBFHHEjAGzSmK5UA,2660
-pykubegrader/tokens/token_panel.py,sha256=NNA5ZV3Q9jB_lz2aSwMyViXV0ESu6V_7T92Qji7UpSQ,1377
-pykubegrader/tokens/tokens.py,sha256=qcYMFgNPimbfeS7lXOtbgquGgeJCgOGx5hvXewIs0oQ,1474
+pykubegrader/submit/submit_assignment.py,sha256=73bbCYNfeWHjxZw-TUuva737WEPQNA9DB6czeP5BIOM,2656
+pykubegrader/tokens/generator.py,sha256=zqfO8GX4Xkhkxi0HGkGwiwuXTmL4ON_hcH8f-9Gg5qc,2648
+pykubegrader/tokens/token_panel.py,sha256=jWwOUx4mr67iWyoIyjITMtwf9HtbAd_L5b-2x_Fif3g,1377
+pykubegrader/tokens/tokens.py,sha256=5hEcNMUCpFtps0OjWV1V93zdk2cuIAwCfhBEp3PiuEI,1473
 pykubegrader/tokens/validate_token.py,sha256=kvHX0NJBm21xzb2p67j7vq1La6J1XbmobEJQ3fTMdZA,3289
 pykubegrader/widgets/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 pykubegrader/widgets/multiple_choice.py,sha256=ag6W-HN7isHkIUmB4BxtK8T1JhuV3FBLUBAhcV6rN80,2729
@@ -31,12 +36,12 @@ pykubegrader/widgets/style.py,sha256=fVBMYy_a6Yoz21avNpiORWC3f5FD-OrVpaZ3npmunvs
 pykubegrader/widgets/true_false.py,sha256=QllIhHuJstJft_RuShkxI_fFFTaDAlzNZOFNs00HLIM,2842
 pykubegrader/widgets/types_question.py,sha256=kZdRRXyFzOtYTmGdC7XWb_2oaxqg1WSuLcQn_sTj6Qc,2300
 pykubegrader/widgets_base/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-pykubegrader/widgets_base/multi_select.py,sha256=KtfAP0PyEbcjWlKNpI5_5-PLMtcUbbNX0Es_-w-H34Q,4226
+pykubegrader/widgets_base/multi_select.py,sha256=WhpS7a8V3BOuEfEyFPzcDhMbgr7p1a4FFh_mKU1HLbI,4226
 pykubegrader/widgets_base/reading.py,sha256=ChUS3NOTa_HLtNpxR8hGX80LPKMvYMypnR6dFknfxus,5430
-pykubegrader/widgets_base/select.py,sha256=uMncmVIqjvJkffMQY1L_PokrFCidK1PeVITX0i70fho,2750
-PyKubeGrader-0.3.8.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
-PyKubeGrader-0.3.8.dist-info/METADATA,sha256=qrucw04y1mZfpYfKihEEtqTjQ9SLh5YKDgBA_GNQJ2s,2729
-PyKubeGrader-0.3.8.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-PyKubeGrader-0.3.8.dist-info/entry_points.txt,sha256=RR57KvzDRJrP4omy5heS5cZ3E7g56YxcxJhDnp57ZU0,253
-PyKubeGrader-0.3.8.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
-PyKubeGrader-0.3.8.dist-info/RECORD,,
+pykubegrader/widgets_base/select.py,sha256=qP31bjTWIn8LEgKwtNUJbgJnum6P7bx6A_At-u1ivFk,2750
+PyKubeGrader-0.3.10.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
+PyKubeGrader-0.3.10.dist-info/METADATA,sha256=lM-bIik76huAUbqHX0y0fhftiNbaOUoDwDTt6Ut7b8Q,2758
+PyKubeGrader-0.3.10.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+PyKubeGrader-0.3.10.dist-info/entry_points.txt,sha256=RR57KvzDRJrP4omy5heS5cZ3E7g56YxcxJhDnp57ZU0,253
+PyKubeGrader-0.3.10.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
+PyKubeGrader-0.3.10.dist-info/RECORD,,

pykubegrader/build/api_notebook_builder.py

@@ -100,7 +100,7 @@ class FastAPINotebookBuilder:
 
             cell = self.get_cell(cell_index)
             cell_source = FastAPINotebookBuilder.add_import_statements_to_tests(
-                cell["source"], require_key=self.require_key,
+                cell["source"], require_key=self.require_key, assignment_tag = self.assignment_tag,
             )
 
             cell_source = FastAPINotebookBuilder.conceal_tests(cell_source)
@@ -224,7 +224,7 @@ class FastAPINotebookBuilder:
 
         if self.require_key:
             first_cell_header.append(
-                "from pykubegrader.tokens.validate_token import validate_token\nvalidate_token()\n"
+                f"from pykubegrader.tokens.validate_token import validate_token\nvalidate_token(assignment='{self.assignment_tag}')\n"
             )
 
         short_filename = self.filename.split(".")[0].replace("_temp", "")
@@ -330,7 +330,7 @@ class FastAPINotebookBuilder:
         return original_list[:index] + insert_list + original_list[index:]
 
     @staticmethod
-    def add_import_statements_to_tests(cell_source: list[str], require_key:bool = False) -> list[str]:
+    def add_import_statements_to_tests(cell_source: list[str], require_key:bool = False, assignment_tag = None) -> list[str]:
         """
         Adds the necessary import statements to the first cell of the notebook.
         """
@@ -353,7 +353,7 @@ class FastAPINotebookBuilder:
 
         if require_key:
             imports.append(
-                "from pykubegrader.tokens.validate_token import validate_token\nvalidate_token()\n"
+                f"from pykubegrader.tokens.validate_token import validate_token\nvalidate_token(assignment='{assignment_tag}')\n"
             )
 
         for i, line in enumerate(cell_source):

pykubegrader/build/build_folder.py

@@ -785,7 +785,7 @@ class NotebookProcessor:
             nbformat.write(notebook, f)
 
     @staticmethod
-    def add_validate_block(notebook_path: str, require_key: bool, **kwargs) -> None:
+    def add_validate_block(notebook_path: str, require_key: bool, assignment_tag = None, **kwargs) -> None:
         """
         Modifies the first code cell of a Jupyter notebook to add the validate_token call if require_key is True.
 
@@ -804,7 +804,7 @@ class NotebookProcessor:
             notebook = nbformat.read(f, as_version=4)
 
         # Prepare the validation code
-        validation_code = "validate_token()\n"
+        validation_code = f"validate_token(assignment = '{assignment_tag}')\n"
 
         # Modify the first cell if it's a code cell, otherwise insert a new one
         if notebook.cells and notebook.cells[0].cell_type == "code":

pykubegrader/grade_reports/assignments.py

@@ -0,0 +1,184 @@
+import numpy as np
+from dateutil import parser
+from datetime import datetime
+from pykubegrader.graders.late_assignments import calculate_late_submission
+
+
+class assignment_type:
+    """
+    Base class for assignment types.
+
+    Attributes:
+        weight (float): The weight of the assignment in the overall grade.
+
+    Methods:
+        __init__(name: str, weekly: bool, weight: float):
+            Initializes an instance of the assignment_type class.
+    """
+
+    def __init__(self, name: str, weekly: bool, weight: float):
+        """Initializes an instance of the assignment_type class.
+        Args:
+            name (str): The name of the assignment.
+            weekly (bool): Indicates if the assignment is weekly.
+            weight (float): The weight of the assignment in the overall grade."""
+        self.name = name
+        self.weekly = weekly
+        self.weight = weight
+
+
+class Assignment(assignment_type):
+    """
+    Class for storing and updating assignment scores.
+
+    Attributes:
+        week (int, optional): The week number of the assignment.
+        exempted (bool): Indicates if the assignment is exempted.
+        graded (bool): Indicates if the assignment has been graded.
+        late_adjustment (bool): Indicates if late submissions are allowed.
+        students_exempted (list): List of student IDs exempted from the assignment.
+        due_date (datetime, optional): The due date of the assignment.
+        max_score (float, optional): The maximum score possible for the assignment.
+        grade_adjustment_func (callable, optional): Function to adjust the grade for late or exempted submissions.
+
+    Methods:
+        add_exempted_students(students):
+            Add students to the exempted list.
+
+        update_score(submission=None):
+            Update the score of the assignment based on the submission.
+
+        grade_adjustment(submission):
+            Apply the adjustment function if provided.
+    """
+
+    def __init__(
+        self,
+        name: str,
+        weekly: bool,
+        weight: float,
+        score: float,
+        grade_adjustment_func=None,
+        **kwargs,
+    ):
+        """
+        Initializes an instance of the Assignment class.
+
+        weekly (bool): Indicates if the assignment is weekly.
+        grade_adjustment_func (callable, optional): Used to calculate the grade in the case of late or exempted submissions. Defaults to None.
+        **kwargs: Additional keyword arguments.
+            week (int, optional): The week number of the assignment. Defaults to None.
+            exempted (bool, optional): Indicates if the assignment is exempted. Defaults to False.
+            graded (bool, optional): Indicates if the assignment is graded. Defaults to False.
+            late_adjustment (bool, optional): Indicates if late adjustment is applied. Defaults to True.
+            students_exempted (list, optional): List of students exempted from the assignment. Defaults to an empty list.
+            due_date (datetime, optional): The due date of the assignment. Defaults to None.
+            max_score (float, optional): The maximum score possible for the assignment. Defaults to None.
+        """
+        super().__init__(name, weekly, weight)
+        self.score = score
+        self._score = score
+        self.week = kwargs.get("week", None)
+        self.exempted = kwargs.get("exempted", False)
+        self.graded = kwargs.get("graded", False)
+        self.late_adjustment = kwargs.get("late_adjustment", True)
+        self.students_exempted = kwargs.get("students_exempted", [])
+        self.due_date = kwargs.get("due_date", None)
+        self.max_score = kwargs.get("max_score", None)
+
+        # Store the function for later use
+        self.grade_adjustment_func = grade_adjustment_func
+
+    def add_exempted_students(self, students):
+        """
+        Add students to the exempted list.
+        Args:
+            students (list): List of student IDs to exempt from the assignment.
+        """
+        self.students_exempted.extend(students)
+
+    def update_score(self, submission=None):
+        """Updates the assignment score based on the given submission.
+
+        This method adjusts the score using the `grade_adjustment` function if a submission
+        is provided. If the submission results in a higher score than the current score,
+        the assignment score is updated. If no submission is provided and the student is
+        not exempted, the score is set to zero. If the student is exempted, the score
+        is set to NaN.
+
+        Args:
+            submission (dict, optional): The submission data, expected to contain relevant
+                details for grading. Defaults to None.
+
+        Returns:
+            float: The updated assignment score. If exempted, returns NaN. If no submission
+                is provided, returns 0.
+        """
+        if self.exempted:
+            self.score = np.nan
+
+            # Saves a table with the score of the exempted assignment still recorded.
+            try: 
+                # Adjust the score based on submission
+                score_ = self.grade_adjustment(submission)
+                if score_ > self._score:
+                    self._score = score_
+            except:
+                pass
+            return self.score
+        elif submission is not None:
+            # Adjust the score based on submission
+            score_ = self.grade_adjustment(submission)
+
+            # Update the score only if the new score is higher
+            if score_ > self.score:
+                self.score = score_
+                self._score = score_
+
+            return self.score
+        else:
+            # Set the score to zero if not exempted and no submission
+            self.score = 0
+            self._score = 0
+            return self.score
+
+    def grade_adjustment(self, submission):
+        """Applies adjustments to the submission score based on grading policies.
+
+        This method applies any provided grade adjustment function to the raw score.
+        If no custom function is given, it determines the final score by considering
+        lateness penalties based on the submission timestamp and due date.
+
+        Args:
+            submission (dict): A dictionary containing:
+                - `"raw_score"` (float): The initial unadjusted score.
+                - `"timestamp"` (str): The submission timestamp in a parsable format.
+
+        Returns:
+            float: The adjusted score, incorporating lateness penalties if applicable.
+                Returns 0 for late submissions if no late adjustment policy is defined.
+        """
+        score = submission["raw_score"]
+        entry_date = parser.parse(submission["timestamp"])
+
+        if self.grade_adjustment_func:
+            return self.grade_adjustment_func(score)
+        else:
+            if self.late_adjustment:
+                # Convert due date to datetime object
+                due_date = datetime.fromisoformat(self.due_date.replace("Z", "+00:00"))
+
+                late_modifier = calculate_late_submission(
+                    due_date.strftime("%Y-%m-%d %H:%M:%S"),
+                    entry_date.strftime("%Y-%m-%d %H:%M:%S"),
+                )
+
+                # Apply late modifier and normalize score
+                return (score / self.max_score) * late_modifier
+            else:
+                # Return normalized score if on time
+                if entry_date < self.due_date:
+                    return score / self.max_score
+                # Assign zero score for late submissions without a late adjustment policy
+                else:
+                    return 0

pykubegrader/grade_reports/class_grade_report.py

@@ -0,0 +1,137 @@
+# # import the password and user from the build folder
+# try:
+#     from pykubegrader.build.passwords import password, user
+# except:  # noqa: E722
+#     print("Passwords not found, cannot access database")
+
+from pykubegrader.grade_reports.grading_config import assignment_type_list, skipped_users
+from pykubegrader.grade_reports.grade_report import GradeReport
+# from ..build.passwords import password, user
+from pykubegrader.telemetry import get_all_students
+
+
+import os
+import requests
+from requests.auth import HTTPBasicAuth
+import socket
+import pandas as pd
+import numpy as np
+import tqdm
+
+# user = user()
+# password = password()
+
+# Set the environment variables for the database
+# os.environ["JUPYTERHUB_USER"] = "jca92"
+# os.environ["TOKEN"] = "token"
+# os.environ["DB_URL"] = "https://engr-131-api.eastus.cloudapp.azure.com/"
+# os.environ["keys_student"] = "capture"
+# os.environ["user_name_student"] = "student"
+
+api_base_url = os.getenv("DB_URL")
+student_user = os.getenv("user_name_student")
+student_pw = os.getenv("keys_student")
+
+
+class ClassGradeReport:
+    """Generates and manages a class-wide grade report.
+
+    This class retrieves a list of students, initializes a structured grade report,
+    and populates it with individual student grade data. The final report includes
+    both assignment-specific grades and a weighted average grade.
+
+    Attributes:
+        student_list (list): A sorted list of all students in the class.
+        all_student_grades_df (pd.DataFrame): A DataFrame storing grades for each student,
+            including assignment scores and a weighted average.
+
+    Methods:
+        setup_class_grades():
+            Initializes an empty DataFrame with assignment names and weighted average columns.
+        update_student_grade(student):
+            Fetches and updates an individual student’s weighted average grades in the DataFrame.
+        fill_class_grades():
+            Iterates through all students to populate the class-wide grade report.
+    """
+
+    def __init__(self, user, password):
+        """Initializes the class grade report.
+
+        Retrieves the student list using authentication, sorts it, and sets up
+        the class-wide grade report by initializing and populating a DataFrame.
+        """
+        self.user = user
+        self.password = password
+        
+        self.student_list = get_all_students(self.user, self.password)
+        self.student_list = list( set(self.student_list)-set(skipped_users) )
+        self.student_list.sort()
+
+        self.setup_class_grades()
+        self.fill_class_grades()
+        self.get_class_stats()
+        
+
+    def setup_class_grades(self):
+        """Creates an empty DataFrame to store grades for all students.
+
+        The DataFrame contains assignment columns and a "Weighted Average Grade" column,
+        with students as index labels.
+        """
+        self.all_student_grades_df = pd.DataFrame(
+            np.nan,
+            dtype=float,
+            index=self.student_list,
+            columns=[a.name for a in assignment_type_list] + ["Weighted Average Grade"],
+        )
+
+    def update_student_grade(self, student):
+        """Fetches and updates the grade report for an individual student.
+
+        Args:
+            student (str): The username or identifier of the student.
+
+        Updates:
+            The student's row in `all_student_grades_df` with their weighted average grades.
+        """
+        report = GradeReport(params={"username": student}, display_=False)
+        row_series = report.weighted_average_grades.transpose().iloc[
+            0
+        ]  # Example transformation
+        row_series = row_series.reindex(self.all_student_grades_df.columns)
+        self.all_student_grades_df.loc[student] = row_series
+
+    def fill_class_grades(self):
+        """Populates the class-wide grade report with data from all students.
+
+        Iterates through the `student_list` and updates the DataFrame by fetching
+        and storing each student's weighted average grades.
+        """
+        for student in tqdm.tqdm(self.student_list):
+            self.update_student_grade(student)
+
+    def get_class_stats(self):
+        """Calculates and stores descriptive statistics for the class-wide grade report.
+        Requires filling class grades first
+        """
+        # Calculate descriptive statistics
+        self.stats_df = self.all_student_grades_df.describe(include='all')
+
+    def write_excel_spreadsheet(self, out_name='output.xlsx'):
+        """Exports the class-wide grade report to an Excel spreadsheet.
+
+        Args:
+            out_name (str, optional): Name of output file. Defaults to 'output.xlsx'.
+        """
+        # Export to Excel with different sheets
+        with pd.ExcelWriter('output.xlsx') as writer:
+            self.all_student_grades_df.to_excel(writer, sheet_name='all_student_grades')
+            self.stats_df.to_excel(writer, sheet_name='performance_statistics')
+
+
+def main():
+    class_grades = ClassGradeReport()
+    print(class_grades.all_student_grades_df)
+
+if __name__ == "__main__":
+    main()