1 ``pygrader`` is a directory-based grade database for grading course
2 assignments. Besides tracking grades locally, you can also use it to
3 automatically mail grades to students and professors associated with
4 the course. For secure communication, PGP_ can be used to sign and/or
5 encrypt any of these emails.
16 I've packaged ``pygrader`` for Gentoo_. You need layman_ and
17 my `wtk overlay`_. Install with::
19 # emerge -av app-portage/layman
21 # emerge -av dev-python/pygrader
26 If you're installing by hand or packaging pycomedi for another
27 distribution, you'll need the following dependencies:
29 ======== =================== ================ =========================
30 Package Purpose Debian_ Gentoo_
31 ======== =================== ================ =========================
32 NumPy_ statistics python-numpy dev-python/numpy
33 pgp-mime_ secure email dev-python/pgp-mime [#pm]
34 nose_ testing (optional) python-nose dev-python/nose
35 ========= =================== ================ =========================
37 If you are developing ``pygrader``, you can use `update-copyright`_ to
38 keep the copyright blurbs up to date.
40 .. [#pm] In the `wtk overlay`_.
45 ``pygrader`` is available as a Git_ repository::
47 $ git clone git://tremily.us/pygrader.git
49 See the homepage_ for details. To install the checkout, run the
52 $ python setup.py install
57 Pygrader will help keep you organized in a course where the students
58 submit homework via email, or the homework submissions are otherwise
59 digital (i.e. scanned in after submission). You can also use it to
60 assign and `manage any type of grade via email`__. In the following
61 sections, I'll walk you through local administration for the ``test``
64 __ `Mailpipe details`_
66 All of the processing involves using the ``pg.py`` command. Run::
75 Pygrader receives submissions and assigns grades via email. In order
76 to send email, it needs to connect to an SMTP_ server. See the
77 pgp-mime documentation for details on configuring you SMTP connection.
78 You can test your SMTP configuration by sending yourself a test
81 $ pg.py -VVV smtp -a rincewind@uu.edu -t rincewind@uu.edu
86 Once you've got email submission working, you need to configure the
87 course you'll be grading. Each course lives in its own directory, and
88 the basic setup looks like the ``test`` example distributed with
89 pygrader. The file that you need to get started is the config file in
90 the course directory::
92 $ cat test/course.conf
95 assignments: Attendance 1, Attendance 2, Attendance 3, Attendance 4,
96 Attendance 5, Attendance 6, Attendance 7, Attendance 8, Attendance 9,
97 Assignment 1, Assignment 2, Exam 1, Exam 2
101 students: Bilbo Baggins, Frodo Baggins, Aragorn
129 nickname: phys-101 robot
130 emails: phys101@tower.edu
139 emails: eye@tower.edu
143 emails: bb@shire.org, bb@greyhavens.net
147 The format is a bit wordy, but it is also explicit and easily
148 extensible. The time it takes to construct this configuration file
149 should be a small portion of the time you will spend grading
152 If a person has the ``pgp-key`` option set, that key will be used to
153 encrypt messages to that person and sign messages from that person
154 with PGP_. It will also be used to authenticate ownership of incoming
155 emails. You'll need to have GnuPG_ on your local host for this to
156 work, and the user running ``pygrader`` should have the associated
157 keys in their keychain.
159 The ``course.robot`` option defines a dummy person used to sign
160 automatically generated emails (e.g. responses to mailpipe-processed
163 The ``submittable`` option marks assignments that accept direct
164 submission from students (e.g. homeworks). You probably don't want to
165 set this option for attendance, since it would allow students to mark
166 themselves as having attended a class. ``submittable`` default to
169 Processing submissions
170 ----------------------
172 As the due date approaches, student submissions will start arriving in
173 your inbox. Use ``pg.py``'s ``mailpipe`` command to sort them into
174 directories (using the ``pygrader.handler.submission`` handler). This
175 will also extract any files that were attached to the emails and place
176 them in that person's assignment directory::
178 $ pg.py -d test mailpipe -m maildir -i ~/.maildir -o ./mail-old
180 Use ``pg.py``'s ``todo`` command to check for ungraded submissions::
182 $ pg.py -d test todo mail grade
184 Then create ``grade`` files using your favorite editor. The first
185 line of the grade file should be the student's grade for that
186 assigment, expressed in a syntax that Python's ``float()`` understands
187 (``1``, ``95``, ``2.5``, ``6.022e23``, etc.). If you wish, you may
188 add additional comment lines after the grade line, offering
189 suggestions for improvement, etc. This comment (if present) will be
190 mailed to the student along with the grade itself. There are a number
191 of example grade files in the ``test`` directory in ``pygrader``'s Git
194 To see how everyone's doing, you can print a table of grades with
195 ``pg.py``'s ``tabulate`` command::
197 $ pg.py -d test tabulate -s
199 When you want to notify students of their grades, you can send them
200 all out with ``pg.py``'s ``email`` command::
202 $ pg.py -d test email assignment 'Exam 1'
207 Besides accepting student submissions from incoming email,
208 ``mailpipe`` also accepts other types of requests, and can be
209 configured to respond automatically:
211 * Incoming student assignment submissions are archived (see the
213 * Students can check their grades without having to bother anyone (see
214 the ``get`` commands).
215 * Professors and teaching assistants can request student submissions
216 so that they can grade them (see the ``get`` commands).
217 * Professors and TAs can request the grades for the entire class (see
218 the ``get`` commands).
219 * Professors and TAs can assign grades (see the ``grade`` command).
221 To enable automatic responses, you'll need to add the ``-r`` or
222 ``--respond`` argument when you call ``pg.py``.
224 If you get tired of filtering your inbox by hand using ``pg.py
225 mailpipe``, you can (depending on how your mail delivery is setup) use
226 procmail_ to automatically run ``mailpipe`` automatically on incoming
227 email. There is an example ``.procmailrc`` in the
228 ``pygrader.mailpipe.mailpipe`` docstring that runs ``mailpipe``
229 whenever incoming emails have ``[phys160:submit]`` in their subject
232 The use of ``[TARGET]`` tags in the email subject allows users to
233 unambiguously specify the purpose of their email. Currently supported
234 targets include (see the ``handlers`` argument to
235 ``pygrader.mailpipe``):
238 student assignment submission. The remainder of the email subject
239 should include the case insensitive name of the assignment being
240 submitted (see ``pygrader.handler.submission._match_assignment``).
241 An example subject would be::
243 [submit] assignment 1
246 request information from the grade database. For students, the
247 remainder of the email subject is irrelevant. Grades and comments
248 for all graded assignments are returned in a single email. An
249 example subject would be::
253 Professors and TAs may request either a table of all grades for the
254 course (à la ``tabulate``), the full grades for a particular
255 student, or a particular student's submission for a particular
256 assignment. Example subjects are (respectively):
258 [get] don't match any student names
260 [get] Bilbo Baggins Assignment 1
263 professors and TAs can submit a grade for a particular student on a
264 particular assignment. The body of the (possibly signed or
265 encrypted) email should be identical to the grade file that the
266 sender wishes to create. An example subject would be::
268 [grade] Bilbo Baggins Assignment 1
270 To allow you to easily sort the email, you can also prefix the target
271 with additional information (see
272 ``pygrader.mailpipe._get_message_target``). For example, if you were
273 running several courses from the same email account, you'd want a way
274 for users to specify which course they were interacting with so you
275 could filter appropriately in your procmail rules. Everything in the
276 subject tag before an optional semicolon is ignored by ``mailpipe``,
277 so the following subjects will be handled identically::
279 [submit] assignment 1
280 [phys101:submit] assignment 1
281 [phys101:section2:submit] assignment 1
286 Run the internal unit tests using nose_::
288 $ nosetests --with-doctest --doctest-tests pygrader
290 If a Python-3-version of ``nosetests`` is not the default on your
291 system, you may need to try something like::
293 $ nosetests-3.2 --with-doctest --doctest-tests pygrader
298 This project is distributed under the `GNU General Public License
299 Version 3`_ or greater.
310 For a similar project, see `Alex Heitzmann's pygrade`_, which keeps
311 the grade history in a single log file and provides more support for
312 using graphical interfaces.
315 .. _PGP: http://en.wikipedia.org/wiki/Pretty_Good_Privacy
316 .. _Gentoo: http://www.gentoo.org/
317 .. _layman: http://layman.sourceforge.net/
318 .. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
319 .. _Debian: http://www.debian.org/
320 .. _Gentoo: http://www.gentoo.org/
321 .. _NumPy: http://numpy.scipy.org/
322 .. _pgp-mime: http://blog.tremily.us/posts/pgp-mime/
323 .. _update-copyright: http://blog.tremily.us/posts/update-copyright/
324 .. _Git: http://git-scm.com/
325 .. _homepage: http://blog.tremily.us/posts/pygrader/
326 .. _SMTP: http://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
327 .. _GnuPG: http://www.gnupg.org/
328 .. _procmail: http://www.procmail.org/
329 .. _nose: http://readthedocs.org/docs/nose/en/latest/
330 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.html
331 .. _Alex Heitzmann's pygrade: http://code.google.com/p/pygrade/