Kmom10: Projekt och examination

Detta kursmoment avslutar och examinerar kursen.

Upplägget är enligt följande:

• Projektet och redovisning (20-36h)

Totalt omfattar kursmomentet (07/10) ca 20+16 studietimmar. Du kan själv styra din arbetsinsats genom att välja vilka optionella delar du utför.

#Förutsättning

Du har jobbat igenom föregående kursmoment.

#Bedömning och betygsättning

När du har lämnat in projektet bedöms det tillsammans med dina tidigare redovisade kursmoment och du får ett slutbetyg på kursen. Läs om grunderna för bedömning och betygsättning.

#Projektidé och upplägg

Du ska utveckla ett program för att öva på att skriva snabbt på ett tangentbord. Det finns många webbsidor som erbjuder det redan, t.ex. https://www.keybr.com/, men vi ska skapa ett program för terminalen. PS Det finns inga tester för projektet. Det är upp till er att tolka och implementera kraven.

#Projektspecifikation

Utveckla och leverera projektet enligt följande specifikationen. Saknas info i specen så kan du själv välja väg, dokumentera dina val i redovisningstexten.

De tre första kraven är obligatoriska och måste lösas för att få godkänt på uppgiften. De tre sista kraven är optionella krav. Lös de optionella kraven för att samla poäng och därmed nå högre betyg.

Varje krav ger max 10 poäng, totalt är det 60 poäng.

Lägg din kod i kmom10/typing. Din kod ska validera i python för att få godkänt.

Du ska implementera ett program för tangentbordsträning. Programmet går ut på att visa användaren en rad åt gången som användaren ska skriva in så snabbt som möjligt. När användaren har skrivit in alla rader då ska ni räkna ut hur bra det gick och visa upp det.

#Krav 1-3

I example/typing finns det tre filer med texter i olika svårighetsgrader, lätt, medel och svårt. Kopiera dem till me/kmom10/typing och använd som input för vad användaren ska skriva.

#Menyval

“1”. Starta skrivtest med filen easy.txt.

“2”. Starta skrivtest med filen medium.txt.

“3”. Starta skrivtest med filen hard.txt.

“4”. Skriv ut resultatlistan som du har sparat i score.txt, sorterad på högst precision.

“q”. Ansluta programmet.

#Vad ett skrivtest är

För menyval 1-3, ett test går ut på att läsa alla rader från filen, skriv ut första raden, vänta på att användaren skriver in samma rad, skriv därefter ut andra raden, vänta på att användaren skriver in samma rad och så vidare tills alla rader har gåtts igenom. Kolla på videon ovanför om ni är osäkra på hur det ska gå till. När testet är klart ska ni skriva ut hur bra användaren presterade.

Efter det ska ni be användaren skriva in sitt namn och så ska ni spara namnet och användarens ordprecision i filen score.txt. Filen score.txt ska innehålla alla som kört ett test och vilken ordprecision de fick.

Räkna ut prestation

När ni ska jämföra resultat utgår vi från orden, orden är separerade med mellanslag. Punkttecken har ingen speciellt betydelse, tänk på dem som vilka bokstäver som helst i ett ord. T.ex. strängen “hej. p-å dig” innehåller tre ord, “hej.”, “p-å” och “dig”.

Skilj också på raderna, om användaren skriver in ett ord för lite eller för mycket vill vi inte att det ska på verka alla ord efteråt. Det påverkar alla ord efteråt i samma input men det ska inte påverkar order i input efteråt. T.ex.

Rätt text:

Hej På Er Idag
Vad gör ni?

Användarens input:

Hej er idag
Vad gör ni?

“På”, “Er” och “Idag” blir fel för att “På” saknas, då matchas “På” till “er”, “Er” till “idag” och “Idag” saknar ord att matcha mot. Varje ny rad ska “börja om”. Andra raden blir 100% rätt.

Ord

Räkna ut ord precision med antal rättstavade ord / totalt antal ord i texten. Om användaren skriver in fler ord än vad som efterfrågas, då ska antalet rättstavade ord minskas med ett för varje extra ord som är skrivit. T.ex. om testet skriver ut 5 ord som användaren ska skriva av och användaren skriver in sju ord där två av orden också är felstavade. Då blir uträkningen 5-2-2 = 1, 1/5 vilket ger 20% precision. Notera att det är case-sensitive, a != A

Tecken

Räkna ut och skriv ut tecken precision med antalet rättstavade tecken / total antal tecken i texten. För att räkna vilka tecken som är rätt. Dela först upp texten i ord (dela på mellanslag) och sen jämför tecken för tecken i orden. Det innebär att mellanslag inte räknas som ett tecken, det är en separator för ord. Om användaren skriver in fler tecken än vad som är med i det efterfrågade ordet ska varje extra tecken sänka antalet rättstavade tecken med ett. Precis som för orden.

Räkna också ut hur många gånger varje korrekt tecken blev felskrivet. Utgå från de korrekta tecknen när du du kollar om de är rätt, inte användarens input. Det är inte tecknet användaren skriver in som ska räknas utan tecknet användaren skulle skriva in men inte gjorde, som ska räknas ut.

T.ex. om programmet skriver ut:
hej På dig Igelkott och användaren skriver in:
he jpå Dig Igelkorr. Då blir följande tecken fel , “j” i “hej”, “P” och “å” i “På”, “d” i “dig” och “t” två gånger i “Igelkott”. Notera att det är case-sensitive, a != A. Det blir följande fel, t 2, j 1, P 1, å 1, och d 1. Eftersom vi jämför per ord och ignorerar mellanslag blir “å” fel i ordet “På”. Då jämför vi “På” med “jpå” vilket gör att “P” blir “j”, “å” blir “p” och “å” i input är extra tecken. Det är 10 rättstavningar av 16, ett tecken för mycket och precisionen blir då (10 - 1) / 16 = 56.2%.

Utskriften ska bestå av vilka tecken som blev fel, sorterat på antalet i utskriften. Tecknet som skrevs fel flest gånger ska skrivas ut först. Skriv också ut precisionen.

Exempel

Här kan ni se ett exempel med input från användaren.

Text från filen:

“Hello my name is Andreas”
“What is your name”
“My name is Da”

Input från användaren:

“Hellå m name andreas”
“What is your nameaa ko”
“”

På sista raden skriver användaren inte in något utan trycker bara på Enter på tangentbordet.

Det ger följande prestation:

Ordprecision: 23.08% # (4-1) / 13
Teckenprecision: 31.82% # (23-9) / 44
Felstavade tecken:  
   s: 3  
   a: 3  
   y: 2  
   n: 2  
   i: 2  
   e: 2  
   r: 1  
   o: 1  
   m: 1  
   d: 1  
   M: 1  
   D: 1  
   A: 1  

#kodstruktur

Din kod ska skrivas i minst två filer. Programmet ska utgå från main.py och du måste skapa minst en till modul som du har kod i.

Din kod ska skrivas i funktioner. Vi godkänner inte kod som ligger utanför funktioner i det globala scopet, förutom enstaka variabler. Tänk på att skriva DRY kod. För långa upprepade kodsnuttar ger minuspoäng.

Du får inte installera moduler med pip. Du får bara importera moduler som vi använt i kursen tidigare och time modulen. Om du vill använda någon annan modul, kontakta kursansvarig och fråga om det är OK.

#Väl fungerande program

Programmet skall fungera utan brister och inte krascha när man använder det enligt kraven. Programmet ska kunna hantera att användaren råkar skriva fel i menyn.

Det ska gå att skriva in färre och fler tecken och ord än vad som skrivs ut utan att programmet kraschar.

Programmet ska inte krascha om filen saknas som används till precisionshistorik.

#Validera och kompatibilitet

Din kod ska validera med pylint.

dbwebb validate kmom10

Det finns inte några färdiga tester, så dbwebb test kmom10 funkar inte.

#Krav 4: Tidtagning (optionell)

För menyval 1-3, lägg till att räkna ut hur lång tid det tar för användaren att skriva in hela texten, i sekunder. Mät tiden från precis innan du skriver ut första raden till att användaren har skrivit in sista raden.

Använd dig av modulen time för att mäta tiden.

#Gross WPM

Räkna ut gross words per minute, antal skrivna ord / minuter. Avrunda minuter uppåt om det tog X minuter och över 30 sekunder. T.ex. 3 minuter och 33 sekunder blir 4 minuter. Om det är under 30 sekunder avrunda ner. T.ex. 2 minuter och 15 sek blir 2 minuter. Allt under 1 minut avrundas upp till en minut.

#Net WPM

Räkna ut net words per minute, gross wpm - (antal felskrivna ord / minuter). I “felskrivna ord” inkludera ord som användaren har skrivit för mycket.

Avrunda minuter uppåt om det tog X minuter och över 30 sekunder. T.ex. 3 minuter och 33 sekunder blir 4 minuter. Om det är under 30 sekunder avrunda ner. T.ex. 2 minuter och 15 sek blir 2 minuter. Allt under 1 minut avrundas upp till en minut.

#Kategori

Ge användaren ett djur som representerar hur snabbt de skrev, baserat på vilken net WPM den fick. När användaren är färdig med ett test visa vilken djur den är. Nedanför hittar ni vilka djur som representerar vilka net WPM.

#Krav 5: Sortera precisionsutskriften (optionell)

När du skriver en användares resultat till score.txt ska du också spara vilken svårighetsnivå testet var. För menyval 4, när du gör utskriften av resultaten ska utskriften vara grupperad efter svårighetsnivå och sorterad efter högst precision. PS. Tänk på att när du sorterar precision ska det vara som decimaltal och inte strängar.

#Krav 6: Skrivtest med slumpade tecken (optionell)

Lägg till menyval 5, i det menyvalet ska användaren välja ett antal sekunder som testet ska pågå. Under så många sekunder ska du slumpa fram ett tecken (bokstäver, siffror och punkter) som användaren ska skriva in så snabbt som möjligt. När tiden har tagit slut ska du skriva ut vilka tecken som blev fel och hur många gånger som det skrevs fel på det tecknet. Utskriften ska vara sorterad i storleksordning på antalet fel. Räkna också ut och skriv ut hur många procent av tecknen som blev fel och antalet tecken per minut som användaren skrev. Inkludera användarens sista input om tiden tar slut under tiden som programmet väntar på att användaren ska skriva.

#Redovisning

1. I inlämningen på Canvas, skriv följande:

   1. För varje krav du implementerat, dvs 1-3, 4, 5, 6, skriver du ett textstycke om ca 5-10 meningar där du beskriver vad du gjort och hur du tänkt. Poängsättningen tar sin start i din text så se till att skriva väl för att undvika poängavdrag. Missar du att skriva/dokumentera din lösning så blir det 0 poäng. Du kan inte komplettera en inlämning för att få högre betyg.
   • Berätta om din kodstruktur och hur du tänkte när du organiserade din kod.

   2. Skriv ett allmänt stycke om hur projektet gick att genomföra. Problem/lösningar/strul/enkelt/svårt/snabbt/lång tid, etc. Var projektet lätt eller svårt? Tog det lång tid? Vad var svårt och vad gick lätt? Var det ett bra och rimligt projekt för denna kursen?

   3. Avsluta med ett sista stycke med dina tankar om kursen och vad du anser om materialet och handledningen (ca 5-10 meningar). Ge feedback till lärarna och förslå eventuella förbättringsförslag till kommande kurstillfällen. Är du nöjd/missnöjd? Kommer du att rekommendera kursen till dina vänner/kollegor? På en skala 1-10, vilket betyg ger du kursen?

2. Glöm inte att bifoga länken till projektet på studentservern (alternativ bara din akronym).

3. Spela in en redovisningsvideo och lägg länken till videon i en kommentar på din inlämning i Canvas. Efter du har gjort inlämningen på Canvas lägg videon som en mediakommentar på din inlämning. Läs mer om hur du kan spela in en redovisningsvideo.

4. Se till att samtliga kursmoment validerar i “dbwebb validate/publish”.

# Ställ dig i kursrepot
dbwebb publish me

#Revision history