ladok3 4.7__py3-none-any.whl → 4.10__py3-none-any.whl

ladok3/report.py

@@ -3,123 +3,160 @@ import datetime
 import ladok3
 import sys
 
+
 def report_one_result(ladok, args):
-  if not (args.course_code and args.component_code and
-    args.student_id and args.grade):
-    print(f"{sys.argv[0]} report: "
-      "not all positional args given: course_code, component, student, grade",
-      file=sys.stderr)
-    sys.exit(1)
-  try:
-    student = ladok.get_student(args.student_id)
-    try:
-      course = student.courses(code=args.course_code)[0]
-    except IndexError:
-      raise Exception("f{args.course_code}: No such course for {student}")
-    try:
-      result = course.results(component=args.component_code)[0]
-    except IndexError:
-      raise Exception(f"{args.component_code}: "
-                      f"No such component for {args.course_code}")
-    result.set_grade(args.grade, args.date)
-    if args.finalize:
-      result.finalize(args.graders)
-  except Exception as err:
+    if not (
+        args.course_code and args.component_code and args.student_id and args.grade
+    ):
+        print(
+            f"{sys.argv[0]} report: "
+            "not all positional args given: course_code, component, student, grade",
+            file=sys.stderr,
+        )
+        sys.exit(1)
     try:
-      print(f"{student}: {err}")
-    except ValueError as verr:
-      print(f"{verr}: {args.student_id}: {err}")
+        student = ladok.get_student(args.student_id)
+        try:
+            course = student.courses(code=args.course_code)[0]
+        except IndexError:
+            raise Exception("f{args.course_code}: No such course for {student}")
+        try:
+            result = course.results(component=args.component_code)[0]
+        except IndexError:
+            raise Exception(
+                f"{args.component_code}: " f"No such component for {args.course_code}"
+            )
+        result.set_grade(args.grade, args.date)
+        if args.finalize:
+            result.finalize(args.graders)
+    except Exception as err:
+        try:
+            print(f"{student}: {err}")
+        except ValueError as verr:
+            print(f"{verr}: {args.student_id}: {err}")
+
 
 def report_many_results(ladok, args):
-  data_reader = csv.reader(sys.stdin, delimiter=args.delimiter)
-  for course_code, component_code, student_id, grade, date, *graders in data_reader:
-    try:
-      student = ladok.get_student(student_id)
+    data_reader = csv.reader(sys.stdin, delimiter=args.delimiter)
+    for course_code, component_code, student_id, grade, date, *graders in data_reader:
+        try:
+            student = ladok.get_student(student_id)
 
-      try:
-        course = student.courses(code=course_code)[0]
-      except IndexError:
-        raise Exception(f"{course_code}: No such course for {student}")
+            try:
+                course = student.courses(code=course_code)[0]
+            except IndexError:
+                raise Exception(f"{course_code}: No such course for {student}")
 
-      try:
-        component = course.results(component=component_code)[0]
-      except IndexError:
-        raise Exception(f"{component_code}: no such component for {course_code}")
+            try:
+                component = course.results(component=component_code)[0]
+            except IndexError:
+                raise Exception(
+                    f"{component_code}: no such component for {course_code}"
+                )
+
+            if not component.attested and component.grade != grade:
+                component.set_grade(grade, date)
+                if args.finalize:
+                    component.finalize(graders)
+                if args.verbose:
+                    print(
+                        f"{course_code} {student}: reported "
+                        f"{component.component} = {component.grade} ({date}) "
+                        f"by {', '.join(graders)}."
+                    )
+            elif component.grade != grade:
+                print(
+                    f"{course_code} {student}: attested {component.component} "
+                    f"result {component.grade} ({component.date}) "
+                    f"is different from {grade} ({date})."
+                )
+        except Exception as err:
+            try:
+                print(
+                    f"{course_code} {component_code}={grade} ({date}) {student}: {err}",
+                    file=sys.stderr,
+                )
+            except ValueError as verr:
+                print(
+                    f"{verr}: "
+                    f"{course_code} {component_code}={grade} ({date}) {student_id}: {err}",
+                    file=sys.stderr,
+                )
 
-      if not component.attested and component.grade != grade:
-        component.set_grade(grade, date)
-        if args.finalize:
-          component.finalize(graders)
-        if args.verbose:
-          print(f"{course_code} {student}: reported "
-                f"{component.component} = {component.grade} ({date}) "
-                f"by {', '.join(graders)}.")
-      elif component.grade != grade:
-        print(f"{course_code} {student}: attested {component.component} "
-          f"result {component.grade} ({component.date}) "
-          f"is different from {grade} ({date}).")
-    except Exception as err:
-      try:
-        print(f"{course_code} {component_code}={grade} ({date}) {student}: {err}",
-          file=sys.stderr)
-      except ValueError as verr:
-        print(f"{verr}: "
-          f"{course_code} {component_code}={grade} ({date}) {student_id}: {err}",
-          file=sys.stderr)
 
 def add_command_options(parser):
-  report_parser = parser.add_parser("report",
-    help="Reports course results to LADOK",
-    description="Reports course results to LADOK"
-  )
-  report_parser.set_defaults(func=command)
-  one_parser = report_parser.add_argument_group(
-    "one result as positional args, only date is optional")
-  one_parser.add_argument("course_code", nargs="?",
-    help="The course code (e.g. DD1315) for which the grade is for"
-  )
+    report_parser = parser.add_parser(
+        "report",
+        help="Reports course results to LADOK",
+        description="Reports course results to LADOK",
+    )
+    report_parser.set_defaults(func=command)
+    one_parser = report_parser.add_argument_group(
+        "one result as positional args, only date is optional"
+    )
+    one_parser.add_argument(
+        "course_code",
+        nargs="?",
+        help="The course code (e.g. DD1315) for which the grade is for",
+    )
 
-  one_parser.add_argument("component_code", nargs="?",
-    help="The component code (e.g. LAB1) for which the grade is for"
-  )
+    one_parser.add_argument(
+        "component_code",
+        nargs="?",
+        help="The component code (e.g. LAB1) for which the grade is for",
+    )
 
-  one_parser.add_argument("student_id", nargs="?",
-    help="Student identifier (personnummer or LADOK ID)"
-  )
+    one_parser.add_argument(
+        "student_id", nargs="?", help="Student identifier (personnummer or LADOK ID)"
+    )
 
-  one_parser.add_argument("grade", nargs="?",
-    help="The grade (e.g. A or P)"
-  )
-  one_parser.add_argument("date", nargs="?",
-    help="Date on ISO format (e.g. 2021-03-18), "
-      f"defaults to today's date ({datetime.date.today()})",
-    type=datetime.date.fromisoformat,
-    default=datetime.date.today()
-  )
-  one_parser.add_argument("graders", nargs="*",
-    help="Space separated list of who did the grading, "
-         "give each grader as 'First Last <email@instutution.se>'.")
-  many_parser = report_parser.add_argument_group(
-    "many results read from standard input as CSV, columns: "
-    "course, component, student, grade, date, grader 1, ..., grader N")
-  many_parser.add_argument("-d", "--delimiter",
-    default="\t",
-    help="The delimiter for the CSV input; "
-      "default is a tab character to be compatible with POSIX commands, "
-      "use `-d,` or `-d ,` to get comma-separated values.")
-  many_parser.add_argument("-v", "--verbose",
-    action="count", default=0,
-    help="Increases the verbosity of the output: -v will print results that "
-      "were reported to standard out. Otherwise only errors are printed.")
-  report_parser.add_argument("-f", "--finalize",
-    help="""Finalize the grade (mark as ready/klarmarkera) for examiner to attest.
+    one_parser.add_argument("grade", nargs="?", help="The grade (e.g. A or P)")
+    one_parser.add_argument(
+        "date",
+        nargs="?",
+        help="Date on ISO format (e.g. 2021-03-18), "
+        f"defaults to today's date ({datetime.date.today()})",
+        type=datetime.date.fromisoformat,
+        default=datetime.date.today(),
+    )
+    one_parser.add_argument(
+        "graders",
+        nargs="*",
+        help="Space separated list of who did the grading, "
+        "give each grader as 'First Last <email@institution.se>'.",
+    )
+    many_parser = report_parser.add_argument_group(
+        "many results read from standard input as CSV, columns: "
+        "course, component, student, grade, date, grader 1, ..., grader N"
+    )
+    many_parser.add_argument(
+        "-d",
+        "--delimiter",
+        default="\t",
+        help="The delimiter for the CSV input; "
+        "default is a tab character to be compatible with POSIX commands, "
+        "use `-d,` or `-d ,` to get comma-separated values.",
+    )
+    many_parser.add_argument(
+        "-v",
+        "--verbose",
+        action="count",
+        default=0,
+        help="Increases the verbosity of the output: -v will print results that "
+        "were reported to standard out. Otherwise only errors are printed.",
+    )
+    report_parser.add_argument(
+        "-f",
+        "--finalize",
+        help="""Finalize the grade (mark as ready/klarmarkera) for examiner to attest.
             Note that without this option, no graders will be registered in LADOK.""",
-    action="store_true",
-    default=False
-  )
+        action="store_true",
+        default=False,
+    )
+
 
 def command(ladok, args):
-  if args.course_code:
-    report_one_result(ladok, args)
-  else:
-    report_many_results(ladok, args)
+    if args.course_code:
+        report_one_result(ladok, args)
+    else:
+        report_many_results(ladok, args)

{ladok3-4.7.dist-info → ladok3-4.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ladok3
-Version: 4.7
+Version: 4.10
 Summary: Python wrapper and CLI for the LADOK3 REST API.
 Home-page: https://github.com/dbosk/ladok3
 License: MIT
@@ -24,7 +24,7 @@ Classifier: Topic :: Utilities
 Requires-Dist: appdirs (>=1.4.4,<2.0.0)
 Requires-Dist: argcomplete (>=2.0.0,<3.0.0)
 Requires-Dist: cachetools (>=5.2.0,<6.0.0)
-Requires-Dist: cryptography (>=39.0.1,<40.0.0)
+Requires-Dist: cryptography (>=41.0.3,<42.0.0)
 Requires-Dist: keyring (>=24.2.0,<25.0.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Requires-Dist: urllib3 (>=1.26.9,<2.0.0)
@@ -69,9 +69,17 @@ command-line tool `ladok`.
 Let's assume that we have a student with personnummer 123456-1234.
 Let's also assume that this student has taken a course with course code AB1234 
 and finished the module LAB1 on date 2021-03-15.
+Say also that the student's assignments were graded by the teacher and two TAs:
+
+  - Daniel Bosk <dbosk@kth.se> (teacher)
+  - Teaching Assistantsdotter <tad@kth.se>
+  - Teaching Assistantsson <tas@kth.se>
+
 Then we can report this result like this:
 ```bash
-ladok report 123456-1234 AB1234 LAB1 -d 2021-03-15 -f
+ladok report 123456-1234 AB1234 LAB1 -d 2021-03-15 -f \
+  "Daniel Bosk <dbosk@kth.se>" "Teaching Assistantsdotter <tad@kth.se>" \
+  "Teaching Assistantsson <tas@kth.se>"
 ```
 
 If we use Canvas for all results, we can even report all results for a 
@@ -84,13 +92,24 @@ canvaslms results -c AB1234 -A LAB1 | ladok report -v
 The `canvaslms results` command will export the results in CSV format, this 
 will be piped to `ladok report` that can read it and report it in bulk.
 
+Most likely you'll need to pass the CSV through `sed` to change the column 
+containing the course identifier to just contain the course code. At KTH, the 
+course code attribute in Canvas contains course code and the semester. So I 
+have to `sed` away the semester part.
+
 ### As a Python package
 
 To use the package, it's just to import the package as usual.
 ```python
 import ladok3
 
-ls = ladok3.kth.LadokSession("user", "password")
+credentials = {
+  "username": "dbosk@ug.kth.se",
+  "password": "password ..."
+}
+
+ls = ladok3.LadokSession("KTH Royal Institute of Technology",
+                         vars=credentials)
 
 student = ls.get_student("123456-1234")
 
@@ -208,7 +227,6 @@ Purpose: Use the data in a Canvas course room together with the data from Ladok3
 
 Input: 
 ```
-Input 
 cl_user_info.py Canvas_user_id|KTHID|Ladok_id [course_id]
 ```
 The course_id can be a Canvas course_id **or** if you have dashboard cards, you can specific a course code, a nickname, unique part of the short name or original course name.

ladok3-4.10.dist-info/RECORD

@@ -0,0 +1,21 @@
+doc/ltxobj/ladok3.pdf,sha256=ZNtJF5DITHsGVrFYbBZ-wyIavggm_gG2Y5WsxNSO6UI,1406261
+ladok3/.gitignore,sha256=QOcCshtjIsFasi4vaqFcooBWPJkxVWaoYEWOBBtdY_w,81
+ladok3/Makefile,sha256=Jy6OFjoVLU9YivnVxctxI_zrUOK9ysEOiistJ3ST6Nw,557
+ladok3/__init__.py,sha256=1Q17HcGR_21FjaBGoIOAS-yQliftHvGX-nO3XSm-92U,245438
+ladok3/api.nw,sha256=pHFU8T2tr2N4kJfyo7uKzNd1lpkd7KICK8lHzV6b1-Y,43304
+ladok3/cli.nw,sha256=57lgiWV9r_JOlv9tRcPviAq3jQB-sgF2loFWg_tf_Ak,21823
+ladok3/cli.py,sha256=gJUksVz_Hi4fjIo3OP6_bG-v505gJtq2nEXBRjdzAq4,11024
+ladok3/data.nw,sha256=3o6-kmeMtCGoSJ5yL8qFCuIINQeym_WtW_2mhItuR-s,11785
+ladok3/data.py,sha256=kPRO9l5DTQb9lGnN2kU-YYPSyg31t0bq5HCw986hbPk,6747
+ladok3/ladok.bash,sha256=zGfTFdtos2zLjV13pzfK-1uCy2b_lF2qUKMoL2ExW7c,1441
+ladok3/ladok3.nw,sha256=6er9_eF1ErShimmpmNh4UkC-EHoLn0HGK8NjzEz_fVM,52289
+ladok3/report.nw,sha256=Bp0-yNVb3NZ0WIj5xn9cpsnY6M60MWMzpX3BC9mXqN0,8972
+ladok3/report.py,sha256=1K7cRaedemiOGDDAMI9wqnctLeic5ZlMYHw5hzhnvQw,5627
+ladok3/student.nw,sha256=zayn9_b9jCKeMnZxSGS_EuSmF3ojOBHQDMUMMkpRssI,3747
+ladok3/student.py,sha256=TaYn2rpbQnzummB-8xz-sUEV31Gh0CUmU0QkF6VgEic,1703
+ladok3/undoc.nw,sha256=NyHuVIzrRqJPM39MyAlZNEE7PbXdUDJFQ2kJ0NfdwQI,180333
+ladok3-4.10.dist-info/LICENSE,sha256=s_C5qznXAvDRrzU7vRd4eqzshyIkAfPwGyVBihGeOdM,1155
+ladok3-4.10.dist-info/METADATA,sha256=5uZYnGaCctnfDcvhhdwLBhAKL3BaHpLNx5bv7pu5G_M,8822
+ladok3-4.10.dist-info/WHEEL,sha256=kLuE8m1WYU0Ig0_YEGrXyTtiJvKPpLpDEiChiNyei5Y,88
+ladok3-4.10.dist-info/entry_points.txt,sha256=pi-KKP5Obo0AyuDjXQUpadS9kIvAY2_5ORhPgEYlJv8,41
+ladok3-4.10.dist-info/RECORD,,

ladok3/kth.py

@@ -1,117 +0,0 @@
-import html
-import ladok3
-import re
-
-class LadokSession(ladok3.LadokSession):
-  def __init__(self, username, password, test_environment=False):
-    """Initialize KTH version of LadokSession"""
-    super().__init__(test_environment=test_environment)
-    self.__username = username
-    self.__password = password
-
-  def ladok_run_shib_login(self, url):
-    response = self.session.get(
-      url=url+'&entityID=https://saml.sys.kth.se/idp/shibboleth')
-            
-    action = re.search(
-      '<form ?[^>]* action="(.*?)"',
-      response.text).group(1)
-
-    csrf_token = re.search(
-      '<input ?[^>]* name="csrf_token" ?[^>]* value="(.*?)"',
-      response.text).group(1)
-
-    post_data = {
-      'csrf_token': csrf_token,
-      'shib_idp_ls_exception.shib_idp_session_ss': '',
-      'shib_idp_ls_success.shib_idp_session_ss': 'true',
-      'shib_idp_ls_value.shib_idp_session_ss': '',
-      'shib_idp_ls_exception.shib_idp_persistent_ss': '',
-      'shib_idp_ls_success.shib_idp_persistent_ss': 'true',
-      'shib_idp_ls_value.shib_idp_persistent_ss': '',
-      'shib_idp_ls_supported': 'true',
-      '_eventId_proceed': ''
-    }
-
-    response = self.session.post(
-      url="https://saml-5.sys.kth.se" + action,
-      data=post_data)
-
-    return response
-  def ug_post_user_pass(self, shib_response):
-    action = re.search('<form ?[^>]* id="loginForm" ?[^>]* action="(.*?)"',
-      shib_response.text).group(1)
-
-    post_data = {
-      'username': self.__username if "@" in self.__username \
-                                  else self.__username + "@ug.kth.se",
-      'password': self.__password,
-      'Kmsi': True,
-      'AuthMethod': "FormsAuthentication"
-    }
-
-    response = self.session.post(
-      url='https://login.ug.kth.se' + action,
-      data=post_data)
-
-    return response
-  def perform_redirects_back_to_ladok(self, ug_response):
-    action = re.search('<form ?[^>]* action="(.*?)"',
-      ug_response.text)
-    if action is None:
-      raise Exception('Invalid username or password OR possibly the SAML \
-        configuration has changed, manually login an accept the changed \
-        information.')
-    action = html.unescape(action.group(1))
-
-    relay_state = re.search(
-      '<input ?[^>]* name="RelayState" ?[^>]* value="(.*?)"',
-      ug_response.text)
-    try:
-      relay_state = html.unescape(relay_state.group(1))
-    except AttributeError:
-      raise Exception(
-        "Try to log in using a web browser and accept sharing data.")
-
-    saml_response = re.search(
-      '<input ?[^>]* name="SAMLResponse" ?[^>]* value="(.*?)"',
-      ug_response.text)
-    saml_response = html.unescape(saml_response.group(1))
-
-    post_data = {
-        'RelayState': relay_state,
-        'SAMLResponse': saml_response
-    }
-
-    response = self.session.post(url=action, data=post_data)
-
-    ladok_action = re.search(
-      '<form ?[^>]* action="(.*?)"',
-      response.text)
-    ladok_action = html.unescape(ladok_action.group(1))
-
-    relay_state = re.search(
-      '<input ?[^>]* name="RelayState" ?[^>]* value="([^"]+)"',
-      response.text)
-    relay_state = html.unescape(relay_state.group(1))
-
-    saml_response = re.search(
-      '<input ?[^>]* name="SAMLResponse" ?[^>]* value="(.*?)"',
-      response.text)
-    saml_response = html.unescape(saml_response.group(1))
-
-    post_data = {
-        'RelayState': relay_state,
-        'SAMLResponse': saml_response
-    }
-
-    response = self.session.post(url=ladok_action, data=post_data)
-
-    return response
-
-  def saml_login(self, url):
-    """Do the SSO login"""
-    response = self.ladok_run_shib_login(url)
-    response = self.ug_post_user_pass(response)
-    response = self.perform_redirects_back_to_ladok(response)
-    return response

ladok3-4.7.dist-info/RECORD

@@ -1,23 +0,0 @@
-doc/ltxobj/ladok3.pdf,sha256=HKjdxKpz0xw17z-2-P6Cyxx-9lRSjp__GR9YEcCLdvw,1338675
-ladok3/.gitignore,sha256=QOcCshtjIsFasi4vaqFcooBWPJkxVWaoYEWOBBtdY_w,81
-ladok3/Makefile,sha256=Jy6OFjoVLU9YivnVxctxI_zrUOK9ysEOiistJ3ST6Nw,557
-ladok3/__init__.py,sha256=q-pAOMPN_jGms0iIyfX8i73oIRaRKwcOmwVqNIS56Ro,229002
-ladok3/api.nw,sha256=pHFU8T2tr2N4kJfyo7uKzNd1lpkd7KICK8lHzV6b1-Y,43304
-ladok3/cli.nw,sha256=M6Rq1YCEGs3dvYh1E_ERAsDL7s229gcphmFyed1I2v8,21682
-ladok3/cli.py,sha256=_Q3noEL5rRxsbqm43HT2x0GXDXv4Mu8tOMOKrOnqOvU,10883
-ladok3/data.nw,sha256=3o6-kmeMtCGoSJ5yL8qFCuIINQeym_WtW_2mhItuR-s,11785
-ladok3/data.py,sha256=mCHySFtQL_oh6mkfMbgRM4T1bnM8HR45eumgoKFwomk,5893
-ladok3/kth.py,sha256=aoodYd2bLQcPNQiFwyP0mppJO399UcqUgUhN9wzVwBA,3720
-ladok3/ladok.bash,sha256=zGfTFdtos2zLjV13pzfK-1uCy2b_lF2qUKMoL2ExW7c,1441
-ladok3/ladok3.nw,sha256=V9QStMwA2dwR-DgWQHCfUEXirJN_y8kauVi2PXYRoHE,50196
-ladok3/report.nw,sha256=vU_z1ZYgf8fV7xeA5R8w6DnOyhdEaNpXtPWa0l07o3A,8972
-ladok3/report.py,sha256=xNKx4lurcJR5DkUIvyCGqt2p_YffchLiHLAOhoAvw8w,4750
-ladok3/student.nw,sha256=zayn9_b9jCKeMnZxSGS_EuSmF3ojOBHQDMUMMkpRssI,3747
-ladok3/student.py,sha256=TaYn2rpbQnzummB-8xz-sUEV31Gh0CUmU0QkF6VgEic,1703
-ladok3/test.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ladok3/undoc.nw,sha256=NyHuVIzrRqJPM39MyAlZNEE7PbXdUDJFQ2kJ0NfdwQI,180333
-ladok3-4.7.dist-info/LICENSE,sha256=s_C5qznXAvDRrzU7vRd4eqzshyIkAfPwGyVBihGeOdM,1155
-ladok3-4.7.dist-info/METADATA,sha256=NUoWZ9ThbbLgd7n-NSTONbtZDW1a4jzoPm-tJaWmZO0,8098
-ladok3-4.7.dist-info/WHEEL,sha256=kLuE8m1WYU0Ig0_YEGrXyTtiJvKPpLpDEiChiNyei5Y,88
-ladok3-4.7.dist-info/entry_points.txt,sha256=pi-KKP5Obo0AyuDjXQUpadS9kIvAY2_5ORhPgEYlJv8,41
-ladok3-4.7.dist-info/RECORD,,