gradescopeapi 1.0.0__tar.gz

gradescopeapi-1.0.0/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 gradescope-api
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gradescopeapi-1.0.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.1
+Name: gradescopeapi
+Version: 1.0.0
+Summary: Library for programmatically interacting with Gradescope.
+Author: Berry Liu, Calvin Tian, Kevin Zheng, Margaret Jagger, Susmitha Kusuma
+Maintainer: Calvin Tian
+License: MIT
+Classifier: Programming Language :: Python :: 3 :: Only
+Project-URL: Homepage, https://github.com/nyuoss/gradescope-api
+Project-URL: Issues, https://github.com/nyuoss/gradescope-api/issues
+Project-URL: Repository, https://github.com/nyuoss/gradescope-api
+Requires-Python: >=3.12
+Requires-Dist: beautifulsoup4>=4.12.3
+Requires-Dist: fastapi>=0.111.0
+Requires-Dist: pytest>=8.2.0
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: requests-toolbelt>=1.0.0
+Requires-Dist: requests>=2.31.0
+Description-Content-Type: text/markdown
+
+# Gradescope API
+
+## Description
+
+This *unofficial* project serves as a library for programmatically interacting with [Gradescope](https://www.gradescope.com/). The primary purpose of this project is to provide students and instructors tools for interacting with Gradescope without having to use the web interface.
+
+For example:
+
+* Students using this project could automatically query information about their courses and assignments to notify them of upcoming deadlines or new assignments.
+* Instructors could use this project bulk edit assignment due dates or sync student extensions with an external system.
+
+## Features
+
+Implemented Features Include:
+
+* Get all courses for a user
+* Get a list of all assignments for a course
+* Get all extensions for an assignment in a course
+* Add/remove/modify extensions for an assignment in a course
+* Add/remove/modify dates for an assignment in a course
+* Upload submissions to assignments
+* API server to interact with library without Python
+
+
+## Demo 
+To get a feel for how the API works, we have provided a demo video of the features in-use: [link](https://youtu.be/eK9m4nVjU1A?si=6GTevv23Vym0Mu8V)
+
+Note that we only demo interacting with the API server, you can alternatively use the Python library directly. 
+
+
+## Setup
+
+To use the project you can install the package from PyPI using pip:
+
+```bash
+pip install gradescopeapi
+```
+
+For additional methods of installation, refer to the [install guide](docs/INSTALL.md)
+
+## Usage
+The project is designed to be simple and easy to use. As such, we have provided users with two different options for using this project.
+
+### Option 1: FastAPI
+
+If you do not want to use Python, you can host the API using the integrated FastAPI server. This way, you can interact with Gradescope using different languages by sending HTTP requests to the API server.
+
+**Running  the API Server Locally**
+
+To run the API server locally on your machine, open the project repository on your machine that you have cloned/forked, and:
+
+1. Navigate to the `src.gradescopeapi.api` directory
+2. Run the command: `uvicorn api:app --reload` to run the server locally
+3. In a web browser, navigate to `localhost:8000/docs`, to see the auto-generated FastAPI docs 
+
+
+### Option 2: Python
+Alternatively, you can use Python to use the library directly. We have provided some sample scripts of common tasks one might do:
+
+```python
+from gradescopeapi.classes.connection import GSConnection
+
+# create connection and login
+connection = GSConnection()
+connection.login("email@domain.com", "password")
+
+"""
+Fetching all courses for user
+"""
+courses = connection.account.get_courses()
+for course in courses["instructor"]:
+    print(course)
+for course in courses["student"]:
+    print(course)
+
+"""
+Getting roster for a course
+"""
+course_id = "123456"
+members = connection.account.get_course_users(course_id)
+for member in members:
+    print(member)
+
+"""
+Getting all assignments for course
+"""
+assignments = connection.account.get_assignments(course_id)
+for assignment in assignments:
+    print(assignment)
+```
+
+For more examples of features not covered here such as changing extensions, uploading files, etc., please refer to the [tests](tests/) directory.
+
+## Testing
+
+For information on how to run your own tests using ```gradescopeapi```, refer to [TESTING.md](docs/TESTING.md)
+
+## Contributing Guidelines
+
+Please refer to the [CONTRIBUTING.md](docs/CONTRIBUTING.md) file for more information on how to contribute to the project.
+
+## Authors
+
+- Susmitha Kusuma
+- Berry Liu
+- Margaret Jagger
+- Calvin Tian
+- Kevin Zheng

gradescopeapi-1.0.0/README.md

@@ -0,0 +1,108 @@
+# Gradescope API
+
+## Description
+
+This *unofficial* project serves as a library for programmatically interacting with [Gradescope](https://www.gradescope.com/). The primary purpose of this project is to provide students and instructors tools for interacting with Gradescope without having to use the web interface.
+
+For example:
+
+* Students using this project could automatically query information about their courses and assignments to notify them of upcoming deadlines or new assignments.
+* Instructors could use this project bulk edit assignment due dates or sync student extensions with an external system.
+
+## Features
+
+Implemented Features Include:
+
+* Get all courses for a user
+* Get a list of all assignments for a course
+* Get all extensions for an assignment in a course
+* Add/remove/modify extensions for an assignment in a course
+* Add/remove/modify dates for an assignment in a course
+* Upload submissions to assignments
+* API server to interact with library without Python
+
+
+## Demo 
+To get a feel for how the API works, we have provided a demo video of the features in-use: [link](https://youtu.be/eK9m4nVjU1A?si=6GTevv23Vym0Mu8V)
+
+Note that we only demo interacting with the API server, you can alternatively use the Python library directly. 
+
+
+## Setup
+
+To use the project you can install the package from PyPI using pip:
+
+```bash
+pip install gradescopeapi
+```
+
+For additional methods of installation, refer to the [install guide](docs/INSTALL.md)
+
+## Usage
+The project is designed to be simple and easy to use. As such, we have provided users with two different options for using this project.
+
+### Option 1: FastAPI
+
+If you do not want to use Python, you can host the API using the integrated FastAPI server. This way, you can interact with Gradescope using different languages by sending HTTP requests to the API server.
+
+**Running  the API Server Locally**
+
+To run the API server locally on your machine, open the project repository on your machine that you have cloned/forked, and:
+
+1. Navigate to the `src.gradescopeapi.api` directory
+2. Run the command: `uvicorn api:app --reload` to run the server locally
+3. In a web browser, navigate to `localhost:8000/docs`, to see the auto-generated FastAPI docs 
+
+
+### Option 2: Python
+Alternatively, you can use Python to use the library directly. We have provided some sample scripts of common tasks one might do:
+
+```python
+from gradescopeapi.classes.connection import GSConnection
+
+# create connection and login
+connection = GSConnection()
+connection.login("email@domain.com", "password")
+
+"""
+Fetching all courses for user
+"""
+courses = connection.account.get_courses()
+for course in courses["instructor"]:
+    print(course)
+for course in courses["student"]:
+    print(course)
+
+"""
+Getting roster for a course
+"""
+course_id = "123456"
+members = connection.account.get_course_users(course_id)
+for member in members:
+    print(member)
+
+"""
+Getting all assignments for course
+"""
+assignments = connection.account.get_assignments(course_id)
+for assignment in assignments:
+    print(assignment)
+```
+
+For more examples of features not covered here such as changing extensions, uploading files, etc., please refer to the [tests](tests/) directory.
+
+## Testing
+
+For information on how to run your own tests using ```gradescopeapi```, refer to [TESTING.md](docs/TESTING.md)
+
+## Contributing Guidelines
+
+Please refer to the [CONTRIBUTING.md](docs/CONTRIBUTING.md) file for more information on how to contribute to the project.
+
+## Authors
+
+- Susmitha Kusuma
+- Berry Liu
+- Margaret Jagger
+- Calvin Tian
+- Kevin Zheng

gradescopeapi-1.0.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+build-backend = "pdm.backend"
+requires = [
+    "pdm-backend",
+]
+
+[project]
+authors = [
+    { name = "Berry Liu" },
+    { name = "Calvin Tian" },
+    { name = "Kevin Zheng" },
+    { name = "Margaret Jagger" },
+    { name = "Susmitha Kusuma" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3 :: Only",
+]
+dependencies = [
+    "beautifulsoup4>=4.12.3",
+    "fastapi>=0.111.0",
+    "pytest>=8.2.0",
+    "python-dotenv>=1.0.1",
+    "requests-toolbelt>=1.0.0",
+    "requests>=2.31.0",
+]
+description = "Library for programmatically interacting with Gradescope."
+maintainers = [
+    { name = "Calvin Tian" },
+]
+name = "gradescopeapi"
+readme = "README.md"
+requires-python = ">=3.12"
+version = "1.0.0"
+
+[project.license]
+text = "MIT"
+
+[project.urls]
+Homepage = "https://github.com/nyuoss/gradescope-api"
+Issues = "https://github.com/nyuoss/gradescope-api/issues"
+Repository = "https://github.com/nyuoss/gradescope-api"
+
+[tool.pdm]
+distribution = true
+
+[tool.pdm.dev-dependencies]
+dev = [
+    "mypy>=1.8.0",
+    "pre-commit>=3.7.0",
+    "ruff>=0.4.3",
+]
+
+[tool.pdm.scripts]
+export = "pdm export -f requirements -o requirements.txt --without-hashes"
+format = "ruff format src tests"
+format-test = "ruff format --check src tests"
+lint = "ruff check src tests"
+lint-fix = "ruff check --fix src tests"
+start = "python -m gradescopeapi"
+test = "pytest tests"

gradescopeapi-1.0.0/src/gradescopeapi/__init__.py

@@ -0,0 +1 @@
+# empty on purpose

gradescopeapi-1.0.0/src/gradescopeapi/__main__.py

@@ -0,0 +1,6 @@
+def main():
+    pass
+
+
+if __name__ == "__main__":
+    main()

gradescopeapi-1.0.0/src/gradescopeapi/_config/config.py

@@ -0,0 +1,65 @@
+"""config.py
+Configuration file for FastAPI. Specifies the specific objects and data models used in our api
+"""
+
+from datetime import datetime
+import io
+from typing import List, Dict, Optional
+from pydantic import BaseModel
+
+
+class UserSession(BaseModel):
+    user_email: str
+    session_token: str
+
+
+class LoginRequestModel(BaseModel):
+    email: str
+    password: str
+
+
+class CourseID(BaseModel):
+    course_id: str
+
+
+class AssignmentID(BaseModel):
+    course_id: str
+    assignment_id: str
+
+
+class StudentSubmission(BaseModel):
+    student_email: str
+    course_id: str
+    assignment_id: str
+
+
+class ExtensionData(BaseModel):
+    course_id: str
+    assignment_id: str
+
+
+class UpdateExtensionData(BaseModel):
+    course_id: str
+    assignment_id: str
+    user_id: str
+    release_date: Optional[datetime] = None
+    due_date: Optional[datetime] = None
+    late_due_date: Optional[datetime] = None
+
+
+class AssignmentDates(BaseModel):
+    course_id: str
+    assignment_id: str
+    release_date: Optional[datetime] = None
+    due_date: Optional[datetime] = None
+    late_due_date: Optional[datetime] = None
+
+
+class FileUploadModel(BaseModel, arbitrary_types_allowed=True):
+    file: io.TextIOWrapper
+
+
+class AssignmentUpload(BaseModel):
+    course_id: str
+    assignment_id: str
+    leaderboard_name: Optional[str] = None