posts:pygrader: update description to match pygrader v0.3.
authorW. Trevor King <wking@tremily.us>
Sun, 2 Sep 2012 20:29:26 +0000 (16:29 -0400)
committerW. Trevor King <wking@tremily.us>
Sun, 2 Sep 2012 20:29:26 +0000 (16:29 -0400)
posts/pygrader.mdwn

index 95441a1ae4c19b8b0555839092187216f90aae1d..8c9703d1ad57c9864812cb9e71e5590b2a30d221 100644 (file)
@@ -16,23 +16,43 @@ art ;), and found that Alex Heitzmann had already created [pygrade][],
 which is the name I under which I had originally developed my own
 project.  While they are both grade databases written in [[Python]],
 Alex's project focuses on providing a more integrated grading
-environment and sharing grading responsibilities among multiple
-graders.
-
-Pygrader don't support multiple graders (yet), and it doesn't spawn
-editors or GUIs to help you browse through submissions or assigning
-grades.  It does pull submissions from your email inbox (or from
-[procmail][]), automatically drop them into a
-`student/assignment/mail` mailbox, extract any [MIME][] attachments
+environment.
+
+Pygrader accepts assignment submissions from students through its
+`mailpipe` command, which you can run on your email inbox (or from
+[procmail][]).  Students submit assignments with an email subject like
+
+    [submit] <assignment name>
+
+`mailpipe` automatically drops the submissions into a
+`student/assignment/mail` mailbox, extracts any [MIME][] attachments
 into the `student/assignment/` directory (without clobbers, with
-proper timestamps), and leave you to get to work (all via the
-`mailpipe` command).
+proper timestamps), and leaves you to get to work.
+
+Pygrader also supports multiple graders through the `mailpipe`
+command.  The other graders can request a student's submission(s) with
+an email subject like
+
+    [get] <student name>, <assignment name>
+
+Then they can grade the submission and mail the grade back with an
+email subject like
+
+    [grade] <student name>, <assignment name>
+
+The grade-altering messages are also stored in the
+`student/assignment/mail` mailbox, so you can peruse them later.
+
+Pygrader *doesn't* spawn editors or GUIs to help you browse through
+submissions or assigning grades.  As far as I am concerned, this is a
+good thing.
 
 When you're done grading, pygrader can email (`email`) your grades and
 comments back to the students, signing or encrypting with [[pgp-mime]]
 if either party has configured a [[PGP]] key.  It can also email a
 tab-delimited table of grades to the professors to keep them up to
-speed.
+speed.  If you're running `mailpipe` via procmail, responses to grade
+request are sent automatically.
 
 While you're grading, pygrader can search for ungraded assignments, or
 for grades that have not yet been sent to students (`todo`).  It can