classresults 0.1.0__tar.gz

classresults-0.1.0/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: classresults
+Version: 0.1.0
+Summary: 
+License-Expression: MIT
+Author: Thomas BOBEE
+Author-email: thomasbobe3@gmail.com
+Requires-Python: >=3.14
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Dist: requests (>=2.34.2,<3.0.0)
+Requires-Dist: setuptools (>=80.0.0,<81.0.0)
+Requires-Dist: xlsxwriter (>=3.2.9,<4.0.0)
+Description-Content-Type: text/markdown
+
+# Install
+To install this package, use:  
+	`pip install ClassResults --index-url https://github.com/totolecr/ClassResults.git`
+
+# Usage
+To use the command, do `ClassResults <activty-code>`.  
+You may need to modify the 'students' variable in the __main__.py file.
+

classresults-0.1.0/README.md

@@ -0,0 +1,7 @@
+# Install
+To install this package, use:  
+	`pip install ClassResults --index-url https://github.com/totolecr/ClassResults.git`
+
+# Usage
+To use the command, do `ClassResults <activty-code>`.  
+You may need to modify the 'students' variable in the __main__.py file.

classresults-0.1.0/classresults/__about__.py

@@ -0,0 +1,3 @@
+__authors__ = "Thomas BOBEE"
+__authors_email__ = "thomasbobe3@gmail.com"
+__version__ = "0.1.0"

classresults-0.1.0/classresults/__init__.py

@@ -0,0 +1,44 @@
+import click
+import sys
+import re
+
+from classresults.get_data import get_data
+
+@click.command()
+@click.argument('activity')
+def main(activity: str):
+    students: list[str] = ["adam.mcibah", "ahash.likitharan", "ahmed.mezghani", "alex.debelli-gonin",
+                           "alexis.kouvoua-fouka",
+                           "baptiste.ducruy", "carol.legout-sales", "clement.raulo", "davy.beninos", "enzo.dugas",
+                           "farah.tab",
+                           "ghali.aboulal", "hong-cheng.taing", "ikram.heroual", "ilian.ben-senouci", "jacques.jiao",
+                           "joachim.joron",
+                           "julie.domrane", "kilen.millot", "lehen.taranne", "levana.zran", "loic.rabetrano",
+                           "marc-shadrack.bumsong-bell", "maxence.gouvaert-de-jesus", "milena.dziekan",
+                           "mohamed-aziz.el-guares",
+                           "mohamed-djibril.touil", "mohamed-rayan.belkacemi", "nada.habbane", "nathanael.isla-y-ortiz",
+                           "noam.assouline", "omar.seif", "quentin.martinet", "robin.menoux", "samuel.huang",
+                           "shadanaa.sivaraja",
+                           "theo.egea", "theo.laradji", "timeo.borghesi", "victor.rousseau", "yoann.papadacci"]
+
+    # Comment this line once done
+    print("This needs a manual setup for students: edit the ClassResult/__main__.py file's students variable according to your students.")
+    regex = re.compile("prog-[0-9]0[0-9]-[pe]-[0-9]{2}-[0-9]{4}")
+    if len(sys.argv) != 2 or sys.argv[1] == "--help":
+        print("Usage: ClassResult <activity>")
+        print(f"\tactivity being the activity code with regex: {regex.pattern}")
+        print(f"\texample: ClassResult prog-101-02-p-2031 for the 2nd practicals of the 2031's first year and first bimester")
+        sys.exit(1)
+
+    activity = sys.argv[1]
+
+    if not regex.match(activity):
+        print(f"Activity name does not obey regular expression: {regex.pattern}")
+        sys.exit(1)
+
+    get_data(sys.argv[1], students)
+
+
+
+
+

classresults-0.1.0/classresults/__main__.py

@@ -0,0 +1,8 @@
+if __name__ == "__main__":
+    import os
+    import sys
+
+    sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+    from classresults import main
+
+    main()

classresults-0.1.0/classresults/get_data.py

@@ -0,0 +1,195 @@
+from typing import Any
+
+import requests
+import poulpy
+import csv
+
+import xlsxwriter
+
+def get_jwt() -> str:
+    """
+    Returns a jwt token using poulpy
+    """
+    return poulpy.get_credentials(poulpy.DefaultProfiles[poulpy.DefaultProfiles.prod.name].value).jwt
+
+def get_raw_data(activity: str, jwt: str) -> list[dict[str, Any]]:
+    """
+    Gets the trace data from the operator's api
+    :param activity: The activity code to get the data from (format: prog-<bimester>-p-<tp number>-<year>)
+    :param jwt: the jwt token
+    :return: The json formated trace data
+    """
+    url = (f"https://operator.forge.epita.fr/api/traces/epita-prepa-computer-science%2F{activity}/explore?pageNum=0&"
+           f"pageSize=100&published=true&submissionDefinitionUri=epita-prepa-computer-science%2F{activity}%2Froot%2F"
+           f"{activity}%2Fsubmit&submissionStatus=SUCCEEDED")
+    headers = {"Accept": "application/json", "Authorization": f"Bearer {jwt}"}
+
+    print("Sending request to operator's api")
+    response = requests.get(url, headers=headers)
+    if response.status_code != 200:
+        raise Exception(f"Invalid response: {response.status_code}")
+
+    json = response.json()
+    traces: list = json["results"]
+    pages = json["pageCount"]
+    print(f"Got: {pages} to load")
+    print("Loaded page number 1")
+    for i in range(1, pages):
+        url = (f"https://operator.forge.epita.fr/api/traces/epita-prepa-computer-science%2F{activity}/explore?"
+               f"pageNum={i}&pageSize=100&published=true&submissionDefinitionUri=epita-prepa-computer-science%2F"
+               f"{activity}%2Froot%2F{activity}%2Fsubmit&submissionStatus=SUCCEEDED")
+        response = requests.get(url, headers=headers)
+        if response.status_code != 200:
+            raise Exception(f"Invalid response: {response.status_code}")
+
+        traces.extend(response.json()["results"])
+        print(f"Loaded page number {i + 1}")
+
+    print("Finished loading traces")
+    return traces
+
+
+def filter_class(data: list[dict[str, Any]], students) -> list[dict[str, Any]]:
+    """
+    Filters data according to students' login
+    :param data: The data to filter
+    :param students: The logins to keep
+    :return: The filtered data
+    """
+    filtered_data = []
+    for trace in data:
+        if trace["author"] in students and trace["author"] not in map(lambda d: d["author"], filtered_data):
+            filtered_data.append(trace)
+
+    print(f"Got trace data for {len(filtered_data)} students out of {len(students)}")
+
+    return filtered_data
+
+
+def recreate_trace_url(activity: str, id: str) -> str:
+    """
+    Assembles the operator's trace url from activity and trace id
+    """
+    return f"https://operator.forge.epita.fr/epita-prepa-computer-science/{activity}/traces/{id}"
+
+
+def recreate_impersonate_url(activity: str, login: str, id: str) -> str:
+    """
+    Assembles the intranet's impersonate url from activity and trace id
+    """
+    return f"https://intra.forge.epita.fr/epita-prepa-computer-science/{activity}/root/{activity}/{id}?login={login}"
+
+
+def to_student_trace(studentdata: list[dict[str, Any]], activity: str) -> list[list]:
+    """
+    Returns a list with all useful data extracted from each trace data
+    """
+    studentTraces = []
+    for student in studentdata:
+        # s = studentTrace(student["author"], student["currentJob"]["successPercent"], student["currentJob"]["traceUrl"])
+        login = student["author"]
+        percent = student["currentJob"]["successPercent"]
+        studentTraces.append([login, percent, recreate_trace_url(activity, student["id"]),
+                              recreate_impersonate_url(activity, login, student["id"])])
+
+    return studentTraces
+
+def add_unsubmitted_students(traces: list[list], students: list[str]) -> list[list]:
+    """
+    Addes all student whose submission was not found as 'Did not submit' students
+    """
+    logins = list(map(lambda r: r[0], traces))
+
+    for student in students:
+        if student not in logins:
+            traces.append([student, "Did not submit", "Did not submit", "Did not submit"])
+
+    traces.sort(key=lambda r: r[0])
+    print(f"Added {len(traces) - len(logins)} students that did not submit")
+    return traces
+
+
+def to_csv(traces, filename):
+    """
+    Saves the data to a csv file
+    """
+    with open(filename, "w", newline="") as f:
+        writer = csv.writer(f)
+        writer.writerow(["login", "percent", "operator url", "impersonate url"])
+        writer.writerows(traces)
+
+
+def to_xlsx(traces, filename):
+    workbook = xlsxwriter.Workbook(filename)
+    sheet = workbook.add_worksheet()
+    sheet.write(0, 0, "login")
+    sheet.write(0, 1, "percent")
+    sheet.write(0, 2, "operator trace url")
+    sheet.write(0, 3, "impersonate url")
+    sheet.write(0, 4, "Did submit")
+
+    for row, (login, percent, url, impersonate) in enumerate(traces):
+        row += 1
+        sheet.write(row, 0, login)
+        if percent != "Did not submit":
+            sheet.write(row, 1, percent / 100)
+            sheet.write_url(row, 2, url, string="operator url")
+            sheet.write_url(row, 3, impersonate, string="impersonate url")
+            sheet.write(row, 4, 1)
+        else:
+            sheet.write(row, 1, 0)
+            sheet.write(row, 4, 0)
+
+    bad_grade = workbook.add_format({'bg_color': '#FF6D6D', 'num_format': 9})
+    low_grade = workbook.add_format({'bg_color': '#FFA365', 'num_format': 9})
+    mid_grade = workbook.add_format({'bg_color': '#FFFF8F', 'num_format': 9})
+    high_grade = workbook.add_format({'bg_color': '#A3FFA3', 'num_format': 9})
+    full_grade = workbook.add_format({'bg_color': '#57FF57', 'num_format': 9})
+    percent = workbook.add_format({'num_format': 9})
+
+    # Add conditionals
+    sheet.conditional_format(1, 1, len(traces), 1,
+                             {"type": "cell", "criteria": "=", "value": 1, "format": full_grade})
+    sheet.conditional_format(1, 1, len(traces), 1,
+                             {"type": "cell", "criteria": ">=", "value": .75, "format": high_grade})
+    sheet.conditional_format(1, 1, len(traces), 1,
+                             {"type": "cell", "criteria": ">=", "value": .50, "format": mid_grade})
+    sheet.conditional_format(1, 1, len(traces), 1,
+                             {"type": "cell", "criteria": ">=", "value": .25, "format": low_grade})
+    sheet.conditional_format(1, 1, len(traces), 1,
+                             {"type": "cell", "criteria": "<", "value": .25, "format": bad_grade})
+
+    sheet.write(8, 8, "Moyenne des derniers submits: ")
+    sheet.write_formula(8, 9,
+                              f"=AVERAGE(FILTER(B2:B{len(traces) + 1},E2:E{len(traces) + 1}))")
+    # Add conditionals
+    sheet.conditional_format(8, 9, 8, 9,
+                             {"type": "cell", "criteria": "=", "value": 1, "format": full_grade})
+    sheet.conditional_format(8, 9, 8, 9,
+                             {"type": "cell", "criteria": ">=", "value": .75, "format": high_grade})
+    sheet.conditional_format(8, 9, 8, 9,
+                             {"type": "cell", "criteria": ">=", "value": .50, "format": mid_grade})
+    sheet.conditional_format(8, 9, 8, 9,
+                             {"type": "cell", "criteria": ">=", "value": .25, "format": low_grade})
+    sheet.conditional_format(8, 9, 8, 9,
+                             {"type": "cell", "criteria": "<", "value": .25, "format": bad_grade})
+
+    sheet.write(9, 8, "Nombre d'élèves ayant au moins 1 submit: ")
+    sheet.write_formula(9, 9, f"=SUM(E2:E{len(traces) + 1})")
+
+    sheet.write(10, 8, "Pourcentage des élèves ayant au moins 1 submit: ")
+    sheet.write_formula(10, 9, f"=ROUND(J10/COUNT(E2:E{len(traces) + 1}),2)", percent)
+
+    sheet.autofit()
+
+    workbook.close()
+
+    print(f"Wrote data to {filename}")
+
+
+def get_data(activity: str, students: list[str]):
+    raw = get_raw_data(activity, get_jwt())
+    filtered = filter_class(raw, students)
+    traces = to_student_trace(filtered, activity)
+    traces = add_unsubmitted_students(traces, students)
+    to_xlsx(traces, "students.xlsx")

classresults-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "classresults"
+version = "0.1.0"
+description = ""
+authors = [
+    {name = "Thomas BOBEE",email = "thomasbobe3@gmail.com"}
+]
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "requests (>=2.34.2,<3.0.0)",
+    "setuptools (>=80.0.0,<81.0.0)",
+    "xlsxwriter (>=3.2.9,<4.0.0)"
+]
+
+[tool.poetry.scripts]
+classresults = "classresults:main"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"