ed-api-client 0.1.0__tar.gz

ed_api_client-0.1.0/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.3
+Name: ed-api-client
+Version: 0.1.0
+Summary: A client for interacting with the Ed LMS
+License: MIT
+Author: David Milne
+Author-email: d.n.milne@gmail.com
+Requires-Python: >=3.6,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: DateTime (>=5.1,<6.0)
+Requires-Dist: dataclasses (==0.6)
+Requires-Dist: pylcs (>=0.1.1,<0.2.0)
+Requires-Dist: python-dateutil (>=2.9.0,<3.0.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Description-Content-Type: text/markdown
+
+# ed-api-client
+
+
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+
+## Add your files
+
+- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
+- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+
+```
+cd existing_repo
+git remote add origin https://gitlab.com/dmilne/ed-api-client.git
+git branch -M main
+git push -uf origin main
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project integrations](https://gitlab.com/dmilne/ed-api-client/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
+- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+

ed_api_client-0.1.0/README.md

@@ -0,0 +1,92 @@
+# ed-api-client
+
+
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+
+## Add your files
+
+- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
+- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+
+```
+cd existing_repo
+git remote add origin https://gitlab.com/dmilne/ed-api-client.git
+git branch -M main
+git push -uf origin main
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project integrations](https://gitlab.com/dmilne/ed-api-client/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
+- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

ed_api_client-0.1.0/ed_api_client/__init__.py

@@ -0,0 +1,9 @@
+from ed_api_client.slides import *
+from ed_api_client.users import *
+from ed_api_client.challenges import *
+from ed_api_client.quizzes import *
+from ed_api_client.assignments import *
+from ed_api_client.workspaces import *
+from ed_api_client.websockets import *
+from ed_api_client.client import *
+from ed_api_client.canvas import *

ed_api_client-0.1.0/ed_api_client/assignments.py

@@ -0,0 +1,241 @@
+from dataclasses import dataclass, field
+from typing import List, Dict, Set
+import datetime
+import math
+
+from ed_api_client import Slide, ChallengeResult, User, QuizResult, Quiz
+from ed_api_client.challenges import ChallengeMarker, MarkType, Challenge
+
+
+@dataclass
+class Assignment:
+    """
+    An assignment against which students are graded
+
+    Attributes
+    ----------
+    name : int
+        The name of the assignment.
+    marks : int
+        The total available marks for this assignment
+    maxScore : int
+        The maximum score that users might achieve on this assignment. This depends on the gradeType:
+            For BY_CHALLENGE this should be the number of challenges.
+            For BY_TESTCASE this should be the number of test cases accross all challenges.
+            For BY_TESTCASE_SCORE this should be the sum of all scores for all test cases across all challenges
+    gradeType: GradeType
+        The approach used for calculating grades
+    deadline: datetime
+        The default deadline beyond which submissions will be penalised.
+    lessonIds: Set[int]
+        The ids of all lessons involved in this assignment (note this is populated automatically as slides are added)
+    slideIds: Set[int]
+        The ids of all slides involved in this assignment (note this is populated automatically as slides are added)
+    challengeIds: List[int]
+        The ids of all challenges involved in this assignment (note this is populated automatically as slides are added)
+    challengeNames: List[str]
+        The names of all challenges involved in this assignment (note this is populated automatically as slides are added)
+    extensionsByStudentId: Dict[int,datetime]
+        Associates ids of students with deadlines that have been given to them (i.e. as extensions)
+
+    Methods
+    ----------
+    add_slide (slide:Slide)
+        Adds a slide (usually a code challenge) to this assignment
+    add_extension (student: User, deadline:datetime)
+        Provides the given student with an extension, until the given deadline
+    get_deadline (student: Student) -> datetime
+        Returns the deadline for the given student
+    get_canvas_col ( ) -> str
+        Returns the name of the column that would match this assignment in an gradebook exported from canvas.
+
+    """
+
+    name: str
+    maxMarks: int
+    marker: ChallengeMarker
+    deadline: datetime.datetime
+    challenges: List[Challenge] = field(default_factory=list)
+    quizzes: List[Quiz] = field(default_factory=list)
+    extensionsByStudentId: Dict[int, datetime.datetime] = field(default_factory=dict)
+    dailyPenalty: float = 0.05
+
+    def add_challenge_slide(self, slide: Slide):
+
+        if slide.challengeId is None:
+            raise ValueError("This slide is not a code challenge")
+
+        self.challenges.append(Challenge(slide.challengeId, slide.id, slide.title))
+
+    def add_quiz_slide(self, slide: Slide, questions: list):
+
+        self.quizzes.append(Quiz(slide.id, slide.title, questions))
+
+    def add_multichoice_solution(self, questionId: int, solution: Set[int]):
+
+        for quiz in self.quizzes:
+
+            if quiz.add_multichoice_solution(questionId, solution):
+                return
+
+        print(f"could not locate multichoice question {questionId}")
+
+    def add_parsons_solution(self, questionId: int, solution: str):
+
+        for quiz in self.quizzes:
+
+            if quiz.add_parsons_solution(questionId, solution):
+                return
+
+        print(f"could not locate parsons question {questionId}")
+
+    def add_extension(self, student, deadline):
+        self.extensionsByStudentId[student.id] = deadline
+
+    def add_extensions(self, students, deadline):
+        for student in students:
+            self.extensionsByStudentId[student.id] = deadline
+
+    def get_deadline(self, student):
+        if student.id in self.extensionsByStudentId:
+            return self.extensionsByStudentId[student.id]
+
+        return self.deadline
+
+    def get_max_score(self):
+        maxScore = 0
+        for quiz in self.quizzes:
+            maxScore = maxScore + quiz.getMaxScore()
+
+        if self.marker.markType == MarkType.BY_CHALLENGE:
+            maxScore = maxScore + (
+                len(self.challenges) * self.marker.pointsPerChallenge
+            )
+        else:
+            maxScore = maxScore + self.marker.maxTestCaseScore
+
+        return maxScore
+
+    def get_canvas_col(self):
+        return "{} ({})".format(self.name, self.id)
+
+
+@dataclass
+class AssignmentResult:
+    """
+    Records the results of a student for an assignment.
+
+    Marks for the assignment include a 10% penalty per day if work is received late.
+    Late submissions are only considered if they improve the student's marks after the late penalty is applied.
+
+    Attributes
+    ----------
+    studentId : int
+        The id of the student
+    completed : bool
+        True if the student successfully completed this assignment, otherwise false.
+    score : int
+        The score recieved by this student
+    mark : float
+        The mark recieved by this student.
+    daysLate: int
+        The number of days past the deadline that work was received and considered.
+    challengeResults: Dict[int, ChallengeResult]
+        Associates ids of challenges with their individual results
+
+    Methods
+    ----------
+    add (submission:Submission,  student:Student, assignment:Assignment)
+        Updates this result based on a single submission
+    finalize (assignment:Assignment, crawler: EdCrawler)
+        To be called after all submissions have been added.
+    """
+
+    studentId: int
+    score: int = None
+    mark: float = None
+    daysLate: int = None
+    penalty: float = None
+    challengeResults: Dict[int, ChallengeResult] = field(default_factory=dict)
+    quizResults: Dict[int, QuizResult] = field(default_factory=dict)
+
+    def add_challenge_submission(self, submission, student, assignment):
+
+        deadline = assignment.get_deadline(student)
+
+        daysLate = 0
+        if submission.markedAt > deadline:
+            diff = submission.markedAt - deadline
+            daysLate = math.ceil(diff.total_seconds() / (60 * 60 * 24))
+
+        if submission.challengeId not in self.challengeResults:
+            self.challengeResults[submission.challengeId] = ChallengeResult()
+
+        self.challengeResults[submission.challengeId].add(submission, daysLate)
+
+    def add_quiz_result(self, quizResult: QuizResult):
+        self.quizResults[quizResult.quizId] = quizResult
+
+    def finalize(self, assignment: Assignment, crawler):
+
+        self.score = 0
+        self.mark = 0
+        self.daysLate = 0
+        self.penalty = 0
+
+        quizScore = 0
+        for quizResult in self.quizResults.values():
+            quizScore = quizScore + quizResult.score
+
+        if self.challengeResults is not None:
+            for challengeId, challenge in self.challengeResults.items():
+                challenge.finalize(assignment.marker, crawler)
+
+        dailyMarkPenalty = assignment.dailyPenalty * assignment.maxMarks
+
+        for daysLate in range(0, 6):
+            score = quizScore
+
+            for challengeId, challenge in self.challengeResults.items():
+                score = score + challenge.scoresByCalendarDaysLate[daysLate]
+
+            mark = assignment.maxMarks * (score / assignment.get_max_score())
+            penalty = daysLate * dailyMarkPenalty
+            mark = mark - penalty
+            if mark < 0:
+                mark = 0
+
+            if mark > self.mark:
+                self.score = score
+                self.mark = mark
+                self.daysLate = daysLate
+                self.penalty = penalty
+
+    def printSummary(self, student: User, assignment: Assignment):
+
+        msg = f"{student.name} got {self.mark:.1f}/{assignment.maxMarks} marks from {self.score}/{assignment.get_max_score()} points"
+
+        if self.daysLate > 0:
+            msg = f"{msg} and a penalty of {self.penalty:.1f} marks for submitting {self.daysLate} days late"
+
+        print(msg)
+
+        for quiz in assignment.quizzes:
+            quizResult = self.quizResults.get(quiz.id)
+
+            if quiz.id is None:
+                print(
+                    f"  0/{quiz.getMaxScore()} points for "
+                    + quiz.name
+                    + " due to no attempt"
+                )
+            else:
+                quizResult.print_summary(quiz)
+
+        for challenge in assignment.challenges:
+
+            challengeResult = self.challengeResults.get(challenge.id)
+            if challengeResult is None:
+                print(f"  0 points for " + challenge.name + " due to no attempt")
+            else:
+                challengeResult.print_summary(challenge, self.daysLate)

ed_api_client-0.1.0/ed_api_client/canvas.py

@@ -0,0 +1,67 @@
+import csv
+from typing import Dict
+
+from ed_api_client import Assignment, Users, AssignmentResult
+
+
+class CanvasExporter:
+    def __init__(self, students: Users):
+        self.__students = students
+        self.__assignmentsByCol = {}
+        self.__resultsByCol = {}
+        self.__fieldNames = ["Student", "ID", "SIS User ID", "SIS Login ID", "Section"]
+
+    def addAssignment(
+        self,
+        assignment: Assignment,
+        columnName: str,
+        results: Dict[int, AssignmentResult],
+    ):
+
+        self.__assignmentsByCol[columnName] = assignment
+        self.__resultsByCol[columnName] = results
+        self.__fieldNames.append(columnName)
+        return self
+
+    def generateCsv(self, sourceCsv, targetCsv):
+
+        with open(sourceCsv) as input:
+            reader = csv.DictReader(input)
+
+            with open(targetCsv, "w") as output:
+                writer = csv.DictWriter(output, fieldnames=self.__fieldNames)
+                writer.writeheader()
+
+                for inputRow in reader:
+
+                    outputRow = self.handleRow(inputRow)
+
+                    if outputRow is None:
+                        continue
+
+                    writer.writerow(outputRow)
+
+    def handleRow(self, inputRow: dict):
+
+        studentEmail = inputRow.get("SIS Login ID")
+        if studentEmail is None:
+            return None
+
+        student = self.__students.getByEmail(studentEmail.lower())
+        if student is None:
+            print(f"Could not locate student {studentEmail}")
+            return None
+
+        outputRow = {}
+        for field in ["Student", "ID", "SIS User ID", "SIS Login ID", "Section"]:
+            outputRow[field] = inputRow[field]
+
+        for col, assignment in self.__assignmentsByCol.items():
+
+            results = self.__resultsByCol.get(col, {}).get(student.id)
+            if results is None:
+                outputRow[col] = 0
+            else:
+                outputRow[col] = round(results.mark, 3)
+
+        return outputRow