ladok3 5.0__tar.gz → 5.1__tar.gz

{ladok3-5.0 → ladok3-5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ladok3
-Version: 5.0
+Version: 5.1
 Summary: Python wrapper and CLI for the LADOK3 REST API.
 Home-page: https://github.com/dbosk/ladok3
 License: MIT

{ladok3-5.0 → ladok3-5.1}/doc/Makefile

@@ -24,6 +24,7 @@ ladok3.pdf: ../examples/example_LadokSession.py
 ladok3.pdf: ../examples/example_Student.py
 ladok3.pdf: ../examples/example_Course.py
 ladok3.pdf: ../examples/canvas2ladok.tex
+ladok3.pdf: ../src/ladok3/scripts.tex
 
 ladok3.pdf: didactic.sty
 

ladok3-5.1/doc/abstract.tex

@@ -0,0 +1,8 @@
+We provide a Python wrapper for the LADOK3 REST API\@.
+This wrapper provide a useful object-oriented framework for working with LADOK 
+and direct API calls that return the unprocessed JSON data directly from 
+LADOK\@.
+
+We also provide a command-line interface (CLI) for the library.
+We then construct some useful (shell) scripts using this CLI\@.
+These scripts automates the reporting of results from Canvas to LADOK\@.

{ladok3-5.0 → ladok3-5.1}/doc/ladok3.tex

@@ -58,7 +58,8 @@ LADOK's web GUI export functions.
 
 You can install the \texttt{ladok3} package by running
 \begin{minted}{bash}
-pip3 install ladok3
+python3 -m pip install ladok3 # to use it in Python, or
+pipx install ladok3           # to just use the CLI
 \end{minted}
 in the terminal.
 
@@ -96,40 +97,25 @@ LADOK expires, it will automatically reauthenticate to establish a new session.
 
 You can find a quick reference by running
 \begin{minted}[firstnumber=last]{bash}
-pydoc ladok3
+pydoc ladok3 # doesn't work if installed with pipx
 \end{minted}
 
 
 
-\part{A command-line interface}
+\part{Example applications}
 
-\chapter{The base interface}
-
-\input{../src/ladok3/cli.tex}
-
-\chapter{The \texttt{course} command}
-
-\input{../src/ladok3/data.tex}
-
-\chapter{The \texttt{report} command}
+\chapter{Transfer results from Canvas to LADOK}\label{SomeScripts}
 
-\input{../src/ladok3/report.tex}
-
-\chapter{The \texttt{student} command}
-
-\input{../src/ladok3/student.tex}
+\input{../src/ladok3/scripts.tex}
 
-
-
-\part{Other example applications}
-
-\chapter{Transfer results from Canvas to LADOK}
+\chapter{Transfer results from Canvas to LADOK in Python}
 
 Here we provide an example program~\texttt{canvas2ladok.py} which exports 
 results from Canvas to LADOK for the introductory programming course~prgi 
 (DD1315).
 
-However, a better way to do this is by using the CLI:
+However, a better way to do this is by using the CLI
+(see \cref{SomeScripts} for an even better version):
 \begin{minted}{bash}
 #!/bin/bash
 
@@ -143,12 +129,6 @@ canvaslms results -c "$courses" -A "$components" \
 | sed -E "s/ ?[HV]T[0-9]{2}( \(.*\))?//" \
 | ladok report -fv
 \end{minted}
-The advantage to using this command is that it will automatically report the 
-correct dates and everyone who has participated in the grading of each 
-student---as required by regulation.
-The official tools, like KTH Transfer to Ladok or SUNET's version of the same, 
-don't do this---they don't set the dates correctly of each individual, but one 
-for all, and they don't register the graders in LADOK.
 
 But now we'll have a look at how we can do this (well, a simpler version) in 
 Python.
@@ -157,7 +137,27 @@ Python.
 \input{../examples/canvas2ladok.tex}
 
 
-\part{The library}
+\part{The command-line interface}
+
+\chapter{The base interface}
+
+\input{../src/ladok3/cli.tex}
+
+\chapter{The \texttt{course} command}
+
+\input{../src/ladok3/data.tex}
+
+\chapter{The \texttt{report} command}
+
+\input{../src/ladok3/report.tex}
+
+\chapter{The \texttt{student} command}
+
+\input{../src/ladok3/student.tex}
+
+
+
+\part{The Python library}
 
 \input{../src/ladok3/ladok3.tex}
 

{ladok3-5.0 → ladok3-5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ladok3"
-version = "5.0"
+version = "5.1"
 description = "Python wrapper and CLI for the LADOK3 REST API."
 authors = [
   "Daniel Bosk <dbosk@kth.se>",

{ladok3-5.0 → ladok3-5.1}/src/ladok3/.gitignore

@@ -8,3 +8,4 @@ prgi.py
 prgi.tex
 ladok.bash
 test.bash
+ladok.sh

{ladok3-5.0 → ladok3-5.1}/src/ladok3/Makefile

@@ -1,9 +1,11 @@
 LIB=	ladok3.nw api.nw undoc.nw
 CLI=	cli.nw data.nw report.nw student.nw
+SCRIPTS=$(shell noroots scripts.nw | sed -E "s/(<<|>>)//g")
 
 .PHONY: all
 all: ${LIB:.nw=.tex} __init__.py
 all: ${CLI:.nw=.tex} ${CLI:.nw=.py} ladok.bash
+all: scripts.tex ${SCRIPTS}
 
 __init__.py: ladok3.py
 	mv $^ $@
@@ -13,6 +15,9 @@ ladok3.py: ${LIB}
 ladok.bash: __init__.py ${CLI:.nw=.py}
 	register-python-argcomplete ladok > $@
 
+${SCRIPTS}: scripts.nw
+	${NOTANGLE.sh}
+
 
 .PHONY: clean
 clean:
@@ -20,6 +25,7 @@ clean:
 	${RM} ${LIB:.nw=.tex}
 	${RM} ${CLI:.nw=.tex}
 	${RM} ${CLI:.nw=.py} ladok.bash
+	${RM} scripts.tex ${SCRIPTS}
 
 .PHONY: distclean
 distclean:

ladok3-5.1/src/ladok3/scripts.nw

@@ -0,0 +1,244 @@
+In this chapter we'll see some scripts for reporting results from Canvas to 
+LADOK.
+These scripts are run as cronjobs.
+This means that they run unattended and only produce output when they need 
+attention.
+
+We want to report results for courses that are titled \enquote{DD2520 VT25}, 
+\enquote{DD1310 HT24}, \enquote{DD1317 HT24}, and similar in Canvas.
+The advantage to using this command is that it will automatically report the 
+correct dates and everyone who has participated in the grading of each 
+student---as required by regulation.
+The official tools, like KTH Transfer to Ladok or SUNET's version of the same, 
+don't do this.
+They don't set the dates correctly, meaning that each individual should have a 
+separate date (date of submission).
+They also don't register the graders in LADOK.
+For each results, everyone who participated in the grading process should be 
+registered in LADOK.
+
+We'll have a script [[<<ladok.sh>>]] that is run by [[cron]].
+It's useful to load our profile, so that we have our normal environment.
+<<ladok.sh>>=
+#!/bin/bash
+. ${HOME}/.profile
+@
+
+We also want some helper functions and a main function that is only run when 
+the script is run.
+If the script is sourced, the main function is not run.
+This way we can use the helper functions in our terminal.
+<<ladok.sh>>=
+<<constants>>
+<<helper functions>>
+
+main() {
+  <<main script>>
+}
+
+# Only run if this is the main script
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+  main "$@"
+fi
+@
+
+We need to report more than once for a course.
+All students might not be done by the time of reporting.
+When they're done, we must report the results again\footnote{%
+  And students have a right to do this without having to reregister on a later 
+  course round.
+}.
+Sometimes a student finishes a course years after it ended.
+To speed up execution it's better to report results for a sliding window of 
+courses, instead of all courses.
+For those rare cases when a student finishes a course years after it ended, we 
+can report the results manually for that course again---by importing and 
+invoking the functions below in the terminal.
+
+We'll let [[YEARS]] be a regex for the years that we're interested in reporting 
+for.
+We'll use the current year and the previous year.
+The advantage of this window is that when we pass new year's eve, the autumn 
+courses are still current for a few weeks---but the year is the wrong one.
+As a side effect, during autumn we report results for any late results for the 
+previous year too.
+
+To construct the regex for years, we simply take a sequence of years
+([[24 25]]) and make a regex ([[(24|25)]]) out of it.
+<<constants>>=
+YEAR=$(date +%y)
+YEARS=$(echo -n "("; \
+        seq $((YEAR - 1)) $YEAR \
+        | sed -zE "s/\s/|/g" \
+        | sed "s/|$/)/")
+@
+
+\section{Reporting results on course components}
+
+We want a script that reports the results for all courses, including all 
+previous years, to LADOK.
+We want to do this for previous years as sometimes they finish assignments 
+years after the course ended.
+
+We'll add a function that takes a course regex and a component regex and 
+reports the results to LADOK.
+To report the modules, we sometimes need to override the default summary 
+function of [[canvaslms]]\footnote{\label{canvaslms-doc}%
+  For details on [[canvaslms results]], see Chapters 10 and 11 in its 
+  documentation, found on
+  \url{https://github.com/dbosk/canvaslms/releases/tag/v4.7}.
+  Particularly Chapter 11 discusses the summary modules.
+  You can also read [[pydoc canvaslms.grades]] for a more brief summary.
+}.
+We want something like this:
+<<main script>>=
+report_components "DD1301 HT${YEARS}" \
+                  LAB1
+report_components "DD131[057] HT${YEARS}" \
+                  "(LAB|MAT|KAL)[1-3]"
+report_components "DA2215 [HV]T${YEARS}" \
+                  INL1
+
+report_components "DD2520 VT${YEARS}" \
+                  INL1
+report_components "DD2520 VT${YEARS}" \
+                  LAB1 \
+                  canvaslms.grades.tilkryLAB1
+@ Note that the line reporting for DD1310 reports for \emph{all} instances as 
+well---that course is given five times in parallel.
+But the assessment should be the same so it is sufficient that one of the 
+examiners run this script to report all the results.
+
+To get the results out of Canvas we'll use the [[canvaslms results]] command.
+We must install the [[canvaslms]] tool.
+We can do this by running:
+\begin{minted}{bash}
+python3 -m pip install canvaslms # to use it with Python, or
+pipx install canvaslms           # to only use the CLI
+canvaslms login                  # or read `canvaslms login --help`
+\end{minted}
+For details on how to extract the results, read
+\mintinline{bash}{canvaslms results --help}
+(also read \cref{canvaslms-doc} on page~\pageref{canvaslms-doc}).
+<<helper functions>>=
+report_components() {
+  local course="$1"
+  local component="$2"
+  local summary_module="$3"
+
+  local summary_opt=""
+  if [[ -n "$summary_module" ]]; then
+    summary_opt="-S $summary_module"
+  fi
+
+  # Get the course results from Canvas.
+  canvaslms results -c "$course" -A "$component" $summary_opt \
+  | sed -E "s/ ?[HV]T[0-9]{2}( \(.*\))?//" \
+  | <<[[tee]] the component results to use for course grades>> \
+  | ladok report -fv # Report them to LADOK.
+}
+@
+
+
+\section{Reporting course grade}
+
+Now we can set the course grades based on the reported components.
+We'll have to report one course at a time since the course grade is based on 
+different components in different courses.
+<<main script>>=
+report_course "DD131[057] HT${YEARS}" \
+              LAB3
+report_course "DD2520 VT${YEARS}" \
+              LAB1
+@ We don't need to report the course grade for the other courses since they 
+have only one component.
+For courses with only one component, LADOK will automatically set the course 
+grade based on the grade of the single component.
+
+Setting the course grade can be done in several ways.
+The first option is to look at what results are already attested in LADOK.
+Unfortunately, this requires the round code---which we don't have access 
+to\footnote{%
+  For a brief period, IT included the round code in the course title in Canvas 
+  at KTH.
+  That was beneficial in many ways, but unfortunately it faced a backlash from 
+  teachers and it was undone.
+}.
+However, we can get this data from the [[canvaslms results]] line in 
+[[report_components]].
+That's why we want to [[tee]] that data out of that pipeline.
+
+When we [[tee]] the data out, we want to use the [[-a]] option to append if the 
+file already exists.
+The reason for this is that we want all results for the course in one file.
+But sometimes we might have to run the script several times---once for each 
+component.
+<<[[tee]] the component results to use for course grades>>=
+tee -a "${DATA_DIR}/${course}-results.csv"
+<<constants>>=
+DATA_DIR=`mktemp -d`
+@
+
+We'll provide a function that takes a course and a component and returns the 
+results for that course and component.
+If no component is given, we use all components.
+If we don't have results from before, we report those components to get the 
+data.
+<<helper functions>>=
+component_grades() {
+  local course="$1"
+  local component="${2:-[A-Z]{3}[0-9]+}"
+  local grades="${DATA_DIR}/${course}-results.csv"
+
+  if [[ ! -f "$grades" ]]; then
+    report_components "$course" "$component"
+  fi
+  cat "$grades" \
+  | grep -E "\s${component}\s" \
+  | sort -u
+}
+@ The data we get here has the following columns (tab separated):
+\begin{minted}{text}
+course    component   student   grade   date   graders
+\end{minted}
+
+Now we can use this file when reporting the course grades.
+If the file doesn't exist, we simply run [[report_components]].
+If the results are not yet attested (certified), the [[ladok report]] command 
+will simply give an error that all components of the course are not yet 
+attested.
+
+Now it's just to sort out the students and then for each student get the grade 
+of the component, get the latest grade date of all components and finally 
+report to LADOK.
+<<helper functions>>=
+report_course() {
+  local course="$1"
+  local component="$2"
+
+  for student in $(component_grades "$course" \
+                   | cut -f 3)
+  do
+    local grade=$(component_grades "$course" "$component" \
+                  | grep "$student" \
+                  | cut -f 4)
+    local grade_date=$(component_grades "$course" \
+                       | grep "$student" \
+                       | cut -f 5 \
+                       | sort \
+                       | tail -n 1)
+
+    if [ "$grade" = "" ]; then
+      continue
+    fi
+
+    local course_code=$(component_grades "$course" "$component" \
+                        | grep "$student" \
+                        | cut -f 1 \
+                        | sort -u)
+
+    # `component code = course code` yields final grade on course.
+    ladok report -fv "$course_code" "$course_code" \
+                     "$student" "$grade" "$grade_date"
+  done
+}

ladok3-5.0/doc/abstract.tex

@@ -1,3 +0,0 @@
-We provide a Python wrapper for the LADOK3 REST API\@.
-We provide a useful object-oriented framework and direct API calls that return 
-the unprocessed JSON data from LADOK.