bump copyright year
[nci.git] / nci-put-assignment-grades.1
blob2c805c301cd4869f1643ff4c46aaeef82760bbd2
1 .Dd 2016-06-12
2 .Dt NCI-PUT-ASSIGNMENT-GRADES 1
3 .Os
4 .Sh NAME
5 .Nm nci-put-assignment-grades
6 .Nd Read a csv of grades from standard input, then connect to a Canvas installation and make the grades match the file
7 .Sh SYNOPSIS
8 .Nm
9 .Sh DESCRIPTION
10 .Nm reads a csv-formatted file
11 .Po
12 see
13 .Sx FILES
14 .Pc
15 from standard input, then connects to a Canvas installation as
16 described at
17 .Xr nci 1 .
18 Every non-empty grade in the csv file that differs from Canvas'
19 recorded grade will be submitted to Canvas to update grading. Cells in
20 the input which are empty will trigger no action.
21 .Sh FILES
22 The input to this program must be in csv format
23 .Pq see RFC 4180 .
24 Any quoting style described in RFC 4180 may be used, although the
25 examples provided here use explicit quotations throughout.
26 .Pp
27 There must be a header line, of the form
28 .Pp
29 .Bl -column
30 .It Qo Name Qc , Ta Qo ID Qc , Ta Qo Ar course-id Ns :  Ns Ar assignment-id  Po Ar assignment-name Pc Qc ,  Ta ...
31 .El
32 .Pp
33 The
34 .Ar assignment-name
35 values will be ignored, but the
36 .Ar course-id
37 and
38 .Ar assignment-id
39 values will be used to determine which assignment to create
40 submissions for. Likewise, the column for student names will be
41 ignored: the column for student IDs will be used to associate grades
42 to students.
43 .Pp
44 Following this will be one line for every student enrolled in
45 .Ar course-id .
46 The current grade for each assignment will be listed in the relevant
47 column. A blank entry indicates that no grade is yet listed. A grade of
48 .Dq EX
49 indicates that the student should be excused from this assignment
50 .Po
51 if a student is currently excused from an assignment and a number is
52 entered, Canvas appears to overwrite their excusement with the grade
53 .Pc .
54 .Sh EXAMPLES
55 .Dl % cat input.csv
56 .Dl \&"Name\&",\&"ID\&",\&"1193095:4209425 (Exam 1)\&",\&"1193095:4209426 (Exam 3)\&"
57 .Dl \&"Arnold,Benedict\&",\&"399414\&",\&"83.4\&",\&"\&"
58 .Dl \&"Burr,Aaron\&",\&"348223\&",\&"94\&",\&"79\&"
59 .Dl \&"Κασσάνδρα\&",\&"3944812\&",\&"\&",\&"EX\&"
60 .Dl % nci-put-assignment-grades < input.csv
61 .Sh SEE ALSO
62 .Xr nci 1
63 .Xr nci-list-assignments 1
64 .Xr nci-list-courses 1
65 .Sh AUTHORS
66 .An S. Gilles Aq Mt sgilles@math.umd.edu