https://github.com/ryanlinjui/cpgrader
A Python package that automatically grades programming assignments.
https://github.com/ryanlinjui/cpgrader
automation grader module package programming-assignments
Last synced: about 1 month ago
JSON representation
A Python package that automatically grades programming assignments.
- Host: GitHub
- URL: https://github.com/ryanlinjui/cpgrader
- Owner: ryanlinjui
- License: agpl-3.0
- Created: 2024-04-29T18:50:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-03T15:59:48.000Z (4 months ago)
- Last Synced: 2025-05-01T12:05:36.164Z (about 2 months ago)
- Topics: automation, grader, module, package, programming-assignments
- Language: Python
- Homepage:
- Size: 27.1 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cpGrader: A Python Package to Grade Programming Assignments Automatically
[](https://github.com/ryanlinjui/cpGrader/actions?query=event%3Apush+branch%3Amain)
[](https://pypi.org/project/cpGrader)
[](https://pypi.org/project/cpGrader)
> cpGrader is designed to be used with the course ["NTNU CSIE Computer Programming I/II"](https://sites.google.com/gapps.ntnu.edu.tw/neokent/teaching) by instructor [neokent (紀博文 Po-Wen Chi)](https://sites.google.com/gapps.ntnu.edu.tw/neokent/about-me).
## Thanks for your Contribution 🌟
[](https://github.com/NaoCoding)
[](https://github.com/mrfish233)
## Installation
```bash
pip install cpGrader
```
# How does it works?
### Stage (You can enable/disable the stage)
- `Extract`: Get all the students's source file from moodle submission folder.
- `Build`: Copy the support files to the student's folder and Compile the student's program.
- `Execute`: Run the student's program by the testcase and Generate output file by each testcase.
- `Verify`: Compare the student's output with the correct plaintext output or the correct program's output.
### Step
1. Download all the student submissions from [Moodle](https://moodle3.ntnu.edu.tw).
2. Think about the testcases and strategies that how to grade the student's assignment.
3. Write a config file.
4. Design the verify function.
5. Run your grader.
# Getting Started
## TOML Config File
- `global`: the global settings (Field below is just for global).
- `support [list]`: the files copied to the student's folder.
- `case`: the testcase settings (Each case can be independent).
- `name [string]`: name of testcase.
- `file [string]`: filepath of testcase file.
- `pts [float | int]`: grading points.
- `correct [string]`: the correct file which is program file (`.c`, `.py`) or plain text file (`.txt`, `.out`).
- `command [string]`: the command to run student's program.
## Basic Example
### Config File
```toml
[global]
support = ["input.bmp", "assignment.h"]
correct = "./correct.c"
command = "./assignment"
[[case]]
name = "case1"
file = "./testcase/1.in"
pts = 5
[[case]]
name = "case2"
file = "./testcase/2.in"
pts = 10
```
### Python Code
```python
from cpGrader import Grader
grader = Grader()
@grader.setcase()
def verify(case_name: str, student_output: str, correct_output: str):
assert student_output == correct_output
grader.run(
moodle_submission_dir="/path/to/submissions_dir"
)
```
> GO AND SEE MORE REAL [EXAMPLES HERE](./examples).
# Pytest Testing
### Run All Examples Test
```bash
pytest
```
### Choose the Test to Run (Wildcard)
```bash
pytest -k 2023-cp1-hw01
```
### Details and Muti-Threading
```bash
pytest -vs -n auto
```