Katalogen innehåller olika skript för att rapportera in resultat på uppgifter i kurser i Canvas på KTH.
Skripten behöver en hemlig nyckel för att kunna användas. För att skapa en sådan hemlig nyckel, kör nyckelskaparen:
$ nyckelskapare.py
Nyckeln sparas i filen hemlig-nyckel.txt och används sedan av skripten.
Alla skript tar åtminstone ett <kursnamn> som argument. Det är en hel eller en del av ett kursnamn som man har en annan roll än student på. Det går att ge smeknamn på kurser, om man exempelvis tycker att ett kursnamn är för långt, genom att köra:
$ smeknamn.py
Skripten kan endast rapportera in resultat för studenter som är inlagda på kurser i Canvas och uppgifterna måste vara i publicerat läge.
Det här skriptet kan användas för att rapportera in enstaka uppgifter för enstaka studenter. Det är interaktivt i bemärkelsen att man tillåts söka upp studenter, uppgifter och sätta resultat genom inmatningsfält i terminalen.
Starta skriptet för en kurs:
$ enstaka.py <kursnamn>
Skriptet är interaktivt och flödet är enligt följande.
- Sök upp en student genom att ange en del av namnet. Om det finns flera studenter får du välja vilken du vill rapportera resultat för.
- Välj uppgift att rapportera för. Här går det antingen att ange uppgiftens namn eller löpnumret på uppgiften från listan med sökresultat (
1,2, ...) - Skriv in ett resultat. Om uppgiften tar emot poäng ska det vara ett heltal och om uppgiften står som godkänd/icke godkänd ska det vara
PellerF. Det går även att ange ett minustecken (-) för att rensa ett tidigare inlagt resultat. - Efter att resultatet har sparats går skriptet tillbaka till steg 2, så att man kan rapportera ytterligare resultat samma student.
Det går alltid att gå tillbaka till föregående steg genom att lämna inmatningsfältet tomt (tryck bara ENTER).
Just nu finns det endast stöd för uppgifter som har poäng, godkänt/icke godkänt eller graderade resultat (typiskt sett A-F) som betygsskala. Skriptet varnar om man är på väg att sätta ett resultat på en gruppuppgift där alla i gruppen får samma resultat, men man får inte reda på vilka andra studenter som är på väg att få det resultatet.
Det här skriptet kan användas för att rapportera in resultat för många studenter och på en gång, från en resultatfil.
Skriptet körs så här:
$ flera.py <kursnamn> [<sökväg till resultatfil>]
Om man anger en sökväg till en resultatfil kommer skriptet importera de resultaten till Canvas, och gör man det inte kommer skriptet i stället att exportera befintliga resultat från Canvas till en fil.
Vid importering kontrolleras innehållet i den angivna resultatfilen mot vad som står i Canvas, och en fil skillnad.xlsx skapas med skillnaden. Det går att ändra i den filen, men för att importera ändringarna (i stället för den ursprungliga resultatfilen), får man avbryta programmet och köra det på nytt, med skillnad.xlsx som andra argument:
$ flera.py <kursnamn> skillnad.xlsx
Resultatfilen ska vara ett kalkylblad på XLSX-format ("Excel-format") där den första raden innehåller kolumnhuvuden och övriga rader är en per student. I den första raden ska det alltid framgå vilken kolumn som innehåller studenternas ID-nummer. Den raden ska även innehålla kolumnhuvuden för de uppgifter som skriptet ska rapportera in resultat för. Kolumenhuvudet med studenternas ID-nummer ska heta ID och kolumnhuvudena med uppgifterna ska sluta med (<ID-nummer>), där <ID-nummer> är respektive uppgifts ID-nummer i Canvas. För att hitta ID-numret för en uppgift, gå in på uppgiften i Canvas och titta i webbläsarens adressfält.
En korrekt formaterat kalkylblad kan fås genom att köra skriptet utan sökväg till en resultatfil:
$ flera.py <kursnamn>
Det går att exportera CSV-filer med resultaten för en kurs från omdömesmatrisen i Canvas webbgränssnitt, men det är verkligen inte att rekommendera. Graderade betyg, till exempel A-F, kan försvinna då de ersätts med numeriska värden som inte alltid entydigt pekar ut precis ett bokstavsbetyg.
Canvas har en möjlighet att importera en CSV-fil som tidigare har exporterats, och på så sätt uppdatera de ändrade betygen. Det kan tyckas göra det här skriptet onödigt, men erfarnheten har visat att Canvas funktion för att importera CSV-filer inte fungerar tillfredsställande. Webbläsaren skickar ett HTTP-anrop per resultat att ändra, sekventiellt. Det sker i bakgrunden, när man har importerat en fil, och som användare får man ingen återkoppling på hur det går om man inte öppnar webbläsarkonsolen och tittar på nätverkstrafiken. Dessutom hoppar den över studenter långt ned i omdömesmatrisen om för stora kurser, vilket gör att vissa resultat inte rapporteras in alls. Ytterligare ett problem är avsaknaden av felhantering; importeringsfunktionen i Canvas ger inget meddelande om ett resultat är felaktigt angivet eller om en student inte är inlagd i kursen. Det här skriptet löser de problemen genom att inte avslutas förrän alla resultat är inrapporterade och genom att vara generös med att skriva ut eventuella felmeddelanden.
När skriptet körs kommer det ske extensiva kontroller av resultatfil. Bland annat följande kontrolleras.
- De angivna uppgifterna existerar för den valda kursen.
- De angivna studenterna är inlagda i den valda kursen.
- Ingen uppgift förekommer flera gånger, i flera kolumnhuvuden.
- Ingen student förekommer flera gånger, i flera rader.
- De angivna resultaten är giltiga för uppgiften; bokstavsbetyg från uppgiftens betygsskala, poäng,
-eller ingenting.
I slutet av 2018 la KTH upp kursrum i Canvas som motsvarade kursomgångarna i det numera nedstängda Rapp. Graderade resultat använder sig av betygsskalor som ligger utanför kursen, vilket gör att de inte går att nå genom API:et, och därmed inte genom enstaka.py och flera.py ovan. Genom att köra
$ rappkorrigering.py <kurs-ID från Canvas>
åtgärdas det genom att kopior på betygsskalorna skapas lokalt på varje enskilt kursrum. Inga resultat ändras till följd av detta.