The nytid from dbosk

Write up use design from automation talk

\begin{frame}[fragile]
  \begin{example}[TA pool]
    \begin{itemize}
      \item \mintinline{bash}{nytid recommend -c "DD131[0-9]" -u [email protected]}
      \item \mintinline{bash}{nytid reqruit -c "prgi23"}
      \item Can use \texttt{ladok3} to filter out graduated students.
    \end{itemize}
  \end{example}
  
  \pause
  \begin{example}[TA sign up]
    \begin{itemize}
      \item \mintinline{bash}{nytid schedule mine --set  https://timeedit...}
      \item \mintinline{bash}{nytid signup -c "prgi23"}
      \item \mintinline{bash}{nytid schedule signed --set ~/public_html/TA.ics}
    \end{itemize}
  \end{example}
\end{frame}
\begin{frame}[fragile]
  \begin{example}[TA confirmation]
    \begin{itemize}
      \item \mintinline{bash}{nytid checkin -c prgi23 --next }
      \item TimeEdit to automate running check-in.
      \item Email or Zulip (or Slack) API to send reminders to check in.
      \item \mintinline{bash}{nytid confirm -c prgi23 --now TA1 TA2 TA3}
      \item \mintinline{bash}{nytid confirm -c prgi23 --time "2023-09-31 13:15"}
    \end{itemize}
  \end{example}
  \pause
  \begin{example}[Reporting hours]
    \begin{itemize}
      \item \mintinline{bash}{nytid report}
    \end{itemize}
  \end{example}
\end{frame}

Changing the schedule, updating the sign-up sheet

Sometimes we add new sessions and we must update the sign-up sheet. Changes:

When we add something, we simply merge and upload a new one.
When we remove a session, we must notify the TAs who signed up. This can easily be done by email.

Add `hr` command

We want to be able to automatically email updates to HR. For instance, when we add new TAs or new TAs sign up, we can automatically send an email to HR to add them.

The command should keep track of what has been sent before and only send differences (the updates).

HR-plus integration

Sell it to the HR department by allowing for the HR people to not have to enter times manually

`nytid hr timesheets generate` stores empty time sheets instead of none

When the time sheet is empty, we don't want to store an empty file. We don't want any file. Check why we get empty files anyway.

Create mine register automatically

Right now the user must set up registers for it to work.

Add installation instructions

In the README
In chapter 1 of the tutorial

Automate finding timeslots for extra sessions

Sometimes we need extra timeslots. Then it's nice if we can automate finding holes in the students' schedules.

Improve time reporting for HR

Let the TAs confirm their times after a session.
Let the TAs add arbitrary times for grading.
Let the course responsible generate an XLSX-file for HR
Allow timesheet generation based on confirmed times or sign-up sheet.

Let course responsible list who are booked for a lab session

Let the course responsible list which TAs are booked for a session. This way they can send reminders/check-ins in Slack/Zulip just before a session.

Output schedule as tab-separated CSV to stdout

Handle bookings for presentations in Canvas

When we know which TAs are available for which sessions, we can add bookable time slots in Canvas automatically. We should also be able to update bookings when more TAs join.

We have to consider how to handle TAs cancelling. If the TA cancels, we must keep track of spots that must be filled. Then, when a new TA joins, we fill the empty seat instead of adding a new one.

Let TAs add their own calendar

If the TAs enter a URL to an ICS file, the tools can automatically filter out the timeslots that they're available.

Add tutorial rooms to tutorial pages in Canvas

Since we have the the rooms and which TAs will run a tutorial, we can write such a booking to the corresponding tutorial page in Canvas.

Eliminate the use of `arrow`

Arrow is not as good as datetime and causes some problems. Also Arrow will be removed from ics in the future.

Look into why we can't have `[[...]]` quotes in section titles

nrnrnr/noweb#40

Design

Daniel:

Då tänkte jag bygga in tidrapporteringen och att boka in sig på labbpass i ett. Så assarna kan köra pytid för att boka in sig på labbar och övningar. Sedan kan de bekräfta tiden efteråt med pytid . Sedan kan jag automatiskt skapa xlsx-filen åt HR.

Precis, de är separata, man måste bekräfta att man är där. Jag tänker mig pytid boka i början av en kurs; pytid start, pytid slut för att logga labbpass (men den defaultar på närmast utsatta pass utifall att man kör dem i efterhand. Sedan pytid rapportera för att skapa en rapport åt HR.

Jag funderar på att lagra data i AFS. Konfig för olika kurser är ju inget problem. Bokningar och rapporterad tid med någon klurig setup av rättigheter. Alternativt något helt annat sätt.

Det är hur mina tankar går just nu. Men vi får se vad jag kommer fram till.

Alexander:

Jag skulle vilja hämta labbpassen från KTH:s REST:api, typ:

import json
import urllib.request
import datetime

KURS  = "DD1310"
START = "2021-09-14"
#END = ""
END = "2021-12-21"

schemaurl = "https://www.kth.se/social/api/schema/v2/course/"+KURS+"?startTime="+START
if END != "": schemaurl += "&endTime=" + END

print("Getting data from:", schemaurl)

request_data = urllib.request.urlopen( schemaurl ).read()
utf_data = request_data.decode('utf-8')
json_data = json.loads(utf_data)

for schemaitem in json_data['entries']:
    # Om det är en Datorlaboration, Laboration eller laboration
    if "aboration" in schemaitem['type_name']['sv']:
        starttid = schemaitem['start']
        datum, tid = starttid.split(' ')
        # veckodag via datetime
        dag = datetime.date(*list([int(x) for x in datum.split('-')])).strftime("%A")[:3]
        tid = tid[:2]
        d, endtid = schemaitem['end'].split()
        endtid = endtid[:2]        
        
        print("Labb", datum, dag, tid, '-', endtid)

Daniel:

Något sådant jag tänkte också. Men jag tänkte sikta på TimeEdit istället för Social. Är Social bättre?

Fördelen jag ser med TimeEdit är att alla lärosäten använder TimeEdit.

The `schedule` subcommands

The schedule command should list the user's schedule.

Track time with calendar

We can add a link to a calendar export where we add time we've worked on the course.

Add default value for `courses new` command

We can add to the config the default value for each parameter in the courses new command.

Consider adding

nytid config courses.new.DD1310.num_students -s 200
nytid config courses.new.DD1310.num_groups -s 6

then run

nytid courses new prgm24 --code DD1310 --ics ...

and the number of students and groups are picked up from the config based on the matching course code.

Add `schedule new` command to add event

We want to easily add a new event to the schedule, so that TAs can book.

However, this can't be done with the sign-up sheets. Since we can't edit the Google Sheet from nytid.

Integrate reminders for Zulip/Slack

Both Zulip and Slack have Python APIs for bots:

Zulip: https://github.com/zulip/python-zulip-api
Slack: https://api.slack.com/tutorials/tags/python

Integrate reminders for TAs, so that we can automatically post who should be where and when etc.

Add command to balance and archive previous HR data

It might be cumbersome to keep all the data from year to year. We should be able to balance and archive when balanced. So that we can prune already processed data.

Add `amanuensis` command

The command should be able to export an "amanuensis contract" including all sessions the TA have included in the amanuensis employment.

This way the command can compute "mertid" when the TA has signed up for more hours. Or extend the contract by emailing HR and Alexander (at the moment).

Use `ics` package to parse schedules

The ics package seems useful for parsing calendars (schedules, TimeEdit, etc.).

Add setup command to guide user through setup

This way we can solve #107 much nicer.

Make `amanuensis show` include a diff

Let the amanuensis show command print the contract and the current status, similar to time. So that we include similar functionality as in #72.

Update cron scripts to automate mertid for amanuensis

Should update the scripts to make use of this to automate the mertid reporting for amanuensis too.

Add `export` command that exports schedule to ICS formatted file

If we allow export of the schedule to an ICS formatted file, we can put that file in ~/public_html/pytid.ics and then import with Google Calendar (or similar). We should let the command do this automatically if the ~/public_html folder exists. Otherwise print it to stdout or a named file.

Improve `amanuensis show --updates` to not reuse `amanuensis create --draft`

We want to fix this to make it more efficient.

Store data in AFS file system

We can store the data somewhere in /afs. We just need correct permissions. Have a default config on KTH servers, so that TAs and course responsible can run it there.

Have a directory for pytid data. Teachers may create subdirectories for courses (through pytid). In this directory we keep course specific configuration and data.

For each course we have a group (created by pytid). The course responsible adds the TAs to the group (through pytid). The TAs can then add or remove themselves from sessions. We could have append-only access for TAs and a format for bookings that add or remove, thus pytid parses all to determine the current status.

Add any time spent on a course

E.g. it should be possible to add meeting time, grading time, actual prep time etc.

Make `hr time` use stored amanuensis contracts

This way we can see the current contracts and if any needs updates.

The big issue is how to figure out which contracts to use.

Let course responsible add sessions and TAs book themselves for sessions

The course responsible should add existing sessions. These should be automatically fetched from TimeEdit. (This also relates to #3.)
Let the TAs book themselves for sessions. (This also relates to #4.)

Add regex matching where suitable

For instance, the --register parameter of nytid courses ls.

Filter which contracts to show with `nytid hr amanuensis show`

We don't want to show last years contracts all the time. Most likely we just want to show the current contract. Or currently active contract. Then we can add an option --all to show all contracts (still non-overlapping).

dbosk / nytid Goto Github PK

nytid's Introduction

nytid

nytid's People

Contributors

Watchers

nytid's Issues

Recommend Projects

Recommend Topics

Recommend Org