|
|
@@ -25,11 +25,62 @@ Usage |
|
|
|
|
|
|
|
kgrader uses rake as its command-line interface. |
|
|
|
|
|
|
|
To do some basic housekeeping: |
|
|
|
### Setup |
|
|
|
|
|
|
|
To load a roster for a course semester: |
|
|
|
|
|
|
|
rake roster cs123 sp2016 myroster.csv |
|
|
|
|
|
|
|
### Grading |
|
|
|
|
|
|
|
To grade a particular assignment (e.g., "mp1" for the "cs123" course): |
|
|
|
|
|
|
|
rake grade cs123 mp1 |
|
|
|
|
|
|
|
After verifying that everything looks good, push the grade reports with: |
|
|
|
|
|
|
|
rake commit cs123 mp1 |
|
|
|
|
|
|
|
### Housekeeping |
|
|
|
|
|
|
|
To show all known classes, semesters, and assignments: |
|
|
|
|
|
|
|
rake list |
|
|
|
|
|
|
|
To do some basic cleanup (i.e., trash uncommitted grading attempts, or reset |
|
|
|
messy internal state after a bad run): |
|
|
|
|
|
|
|
rake clean |
|
|
|
|
|
|
|
To restore kgrader to its factory defaults (i.e., delete checked-out student |
|
|
|
repos and any uncommitted grading attempts): |
|
|
|
To restore kgrader to its "factory defaults" (i.e., everything `clean` does, |
|
|
|
but also delete checked-out student repos and roster files -- dangerous!): |
|
|
|
|
|
|
|
rake clobber |
|
|
|
|
|
|
|
### Advanced |
|
|
|
|
|
|
|
`grade` has an extended syntax for different options. |
|
|
|
|
|
|
|
To specify the semester, instead of the inferred current one: |
|
|
|
|
|
|
|
rake grade cs123 mp1 semester=sp2016 |
|
|
|
|
|
|
|
To set a cutoff date after which commits will be ignored: |
|
|
|
|
|
|
|
rake grade cs123 mp1 due="March 20, 2016 11:59:59 PM CDT" |
|
|
|
|
|
|
|
To grade without fetching new student repo changes: |
|
|
|
|
|
|
|
rake grade cs123 mp1 fetch=no |
|
|
|
|
|
|
|
To grade specific students only: |
|
|
|
|
|
|
|
rake grade cs123 mp1 students=ksmith12 |
|
|
|
rake grade cs123 mp1 students=ksmith12,bcooper3,mjones14 |
|
|
|
|
|
|
|
Normally, kgrader will only regrade a particular student's assignment if their |
|
|
|
repo has changed since the last run. To forcibly regrade: |
|
|
|
|
|
|
|
rake grade cs123 mp1 regrade=yes |
|
|
|
|
|
|
|
You can combine these arguments in any meaningful way. |