Be more verbose on HTTP error messages
[nci.git] / nci-get-assignment-grades.1
bloba23d99b2c6a4b76be993e751af6dd1ea795de276
1 .Dd 2016-06-12
2 .Dt NCI-GET-ASSIGNMENT-GRADES 1
3 .Os
4 .Sh NAME
5 .Nm nci-get-assignment-grades
6 .Nd Print grading information for some assignments from a Canvas installation
7 .Sh SYNOPSIS
8 .Nm
9 .Fl c
10 .Ar course-id
11 .Oo
12 .Fl A
14 .Fl a
15 .Ar assignment-id
16 .Oo
17 .Fl a
18 .Ar assignment-id
19 .Oo ...
20 .Oc
21 .Oc
22 .Oc
23 .Oo
24 .Fl t
25 .Oc
26 .Sh DESCRIPTION
27 .Nm
28 connects to a Canvas installation as described at
29 .Xr nci 1
30 and retrieves all submissions for a given
31 .Ar course-id
32 and all provided
33 .Ar assignment-id Ns s
34 .Pq or all assignments .
35 The printed information will be in CSV format
36 .Pq see RFC 4180 .
37 The encoding is whatever is returned by the Canvas installation, which
38 is probably UTF-8. There will be header line, of the form
39 .Pp
40 .Bl -column
41 .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 ...
42 .El
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. The letters
48 .Dq EX
49 indicate that the student has been excused from this assignment.
50 .Sh OPTIONS
51 .Bl -tag -width Ds
52 .It Fl c
53 The
54 .Ar course-id ,
55 as returned by
56 .Xr nci-list-courses 1 .
57 .It Fl a
59 .Ar assignment-id ,
60 as returned by
61 .Xr nci-list-assignments 1 .
62 Mutually exclusive with
63 .Fl A .
64 .It Fl A
65 Retrieve all assignments.  Mutually exclusive with
66 .Fl a .
67 .It Fl t
68 Include a column for the current total grade in the course, as well
69 as one for computed letter grades. Ungraded assignments are treated as
70 zeroes when performing this calculation.
71 .El
72 .Sh EXAMPLES
73 .Dl % nci-get-assignment-grades -c 1180637 -a 4089590 -a 4089592
74 .Dl Qo Name Qc , Qo ID Qc , Qo 1180637:4089590 (Exam 1) Qc , Qo 1180637:4089592 (Exam 3) Qc
75 .Dl Qo Arnold, Benedict Qc , Qo 399414 Qc , Qo 83.4 Qc , Qo  Qc
76 .Dl Qo Burr, Aaron Qc , Qo 348223 Qc , Qo 94 Qc , Qo 79 Qc
77 .Dl Qo Κασσάνδρα Qc , Qo 3944812 Qc , Qo Qc , Qo EX Qc
79 .Dl % nci-get-assignment-grades -c 1180637 -A
80 .Dl Qo Name Qc , Qo ID Qc , Qo 1180637:4089590 (Exam 1) Qc , Qo 1180637:4089591 (Exam 2) Qc , Qo 1180637:4089592 (Exam 3) Qc
81 .Dl Qo Arnold, Benedict Qc , Qo 399414 Qc , Qo 83.4 Qc , Qo 99 Qc , Qo  Qc
82 .Dl Qo Burr, Aaron Qc , Qo 348223 Qc , Qo 94 Qc , Qo Qc , Qo 79 Qc
83 .Dl Qo Κασσάνδρα Qc , Qo 3944812 Qc , Qo Qc , Qo 83 Qc , Qo EX Qc
85 .Dl % nci-get-assignment-grades -c 1180637 -t
86 .Dl Qo Name Qc , Qo ID Qc , Qo Total Qc , Qo Letter Grade Qc
87 .Dl Qo Arnold, Benedict Qc , Qo 399414 Qc , Qo 60 Qc , Qo A Qc
88 .Dl Qo Burr, Aaron Qc , Qo 348223 Qc , Qo 57.6  Qc , Qo B Qc
89 .Dl Qo Κασσάνδρα Qc , Qo 3944812 Qc , Qo 41.5 Qc , Qo B Qc
90 .Sh SEE ALSO
91 .Xr nci 1
92 .Xr nci-list-assignments 1
93 .Xr nci-list-courses 1
94 .Xr nci-put-assignment-grades 1
95 .Sh AUTHORS
96 .An S. Gilles Aq Mt sgilles@math.umd.edu