dbosk/kthutils

Various utilities for automation at KTH

This package provides various utilities for automation at KTH. It provides the following modules:

• kthutils.ug
  Access the UG editor through Python.

• kthutils.participants
  Read expected course participants through Python.

• kthutils.iprange
  Read IP ranges for computers in lab rooms.

• kthutils.forms
  Read forms data (CSV) from KTH Forms.

We also provide a command-line interface for the modules. This means that the functionality can be accessed through both Python and the shell.

An example

We want to add the user dbosk as teacher in the group

edu.courses.DD.DD1317.20232.1.teachers.

In Python, we would do

import kthutils.credentials
import kthutils.ug

ug = kthutils.ug.UGsession(*kthutils.credentials.get_credentials())

group = ug.find_group_by_name("edu.courses.DD.DD1317.20232.1.teachers")
user = ug.find_user_by_username("dbosk")

ug.add_group_members([user["kthid"]], group["kthid"])

In the shell, we would do

kthutils ug members add edu.courses.DD.DD1317.20232.1.teachers dbosk

Installation and documentation

Install the tools using pip:

python3 -m pip install -U kthutils

You can read the documentation by running pydoc on the package:

python3 -m pydoc kthutils

kthutils's Issues

Make UG JSON objects dataclasses

See the related documentations:

• https://docs.python.org/3/library/dataclasses.html
• https://pypi.org/project/dataclasses-json/

If we use those, we can test if the JSON format changes. Because then the JSON will be incompatible with the dataclass.

Add tests for `forms rewriter`

We currently have no tests. Would be nice to have.

Add module for Kopps

• KOPPS API for Courses
• Example request for DD1310
• Example request for detailed DD1310

Add `forms next` command

We want to have a forms next command that can be used to treat a form as a "generator". This way we just get new things compared to last time we ran it.

Add testing for CLI

https://typer.tiangolo.com/tutorial/testing/

Add support for KTH Forms (and restlabb)

We can read out data from KTH Forms. For instance, Restlabb uses such a form, we can read that form every now and then to report results from restlabb.

Add module for HR+

This module could be integrated into nytid.

Authentication credentials stored in keyring

We should add the keyring as a way to store the credentials.

Generalize forms command

• Add command to list what forms one has access to on KTH Forms.
• Add command to add any form one has access to on KTH Forms.

Create a CLI for kthutils

Should be a CLI called kthutils that has every submodule as a subcommand.

Use typer to construct the CLI. That should be quite straight-forward.