ladok3: Python wrapper for LADOK3 API
This package provides a wrapper for the LADOK3 API used by start.ladok.se. This makes it easy to automate reporting grades, compute statistics etc.
Installation
To install, run:
pip install ladok3
sudo cp $(find / -name ladok.bash) /etc/bash_completion.d
ladok login
If you run the second line above, you'll get tab completion for the ladok
command when you use the bash shell.
The third command above is to log in, you only do this once.
An alternative to installing the package is to run the Docker image.
docker run -it dbosk/ladok3 /bin/bash
Or simply adapt your own image.
Usage
There are two ways to use the package: as a Python package or through the
command-line tool ladok.
On the command line
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:
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 course.
pip install canvaslms
canvaslms login
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.
import ladok3
credentials = {
"username": "dbosk@ug.kth.se",
"password": "password ..."
}
ls = ladok3.LadokSession("KTH Royal Institute of Technology",
vars=credentials)
student = ls.get_student("123456-1234")
course_participation = student.courses(code="AB1234")[0]
for result in course_participation.results():
print(f"{course_participation.code} {result.component}: "
f"{result.grade} ({result.date})")
component_result = course_participation.results(component="LAB1")[0]
component_result.set_grade("P", "2021-03-15")
component_result.finalize()
The simplest way, if you've already run ladok login, is to use the
module-level session attribute:
import ladok3
student = ladok3.session.get_student("123456-1234")
# ...
For experiments against LADOK's test environment there is a sibling
attribute test_session. It shares the underlying authenticated session
with ladok3.session, so using both costs at most one login (MFA prompt).
import ladok3
student = ladok3.test_session.get_student("123456-1234")
# ...
Another way is to use the load_credentials function of the CLI.
import ladok3
import ladok3.cli
ls = ladok3.LadokSession(*ladok3.cli.load_credentials())
student = ls.get_student("123456-1234")
# ...
If you want to reuse a cached session (to avoid re-authenticating), use
get_session:
import ladok3.cli
ls, credentials = ladok3.cli.get_session()
student = ls.get_student("123456-1234")
# ...
More documentation
There are more detailed usage examples in the details documentation that can be
round with the releases and in the examples directory.
The examples
There are some examples that can be found in the examples directory:
example_LadokSession.pyjust shows how to establish a session.example_Course.pyshows course data related examples.example_Student.pyshows student data related examples.canvas2ladok.pyshows how to transfer grades from KTH Canvas to LADOK.statsdata.pyshows how to extract data for doing statistics for a course and the students' results.
We also have a few more examples described in the sections below.
canvas_ladok3_spreadsheet.py
Purpose: Use the data in a Canvas course room together with the data from Ladok3 to create a spreadsheet of students in the course and include their Canvas user_id, name, Ladok3 Uid, program_code, program name, etc.
Note that the course_id can be given as a numeric value or a string which will be matched against the courses in the user's dashboard cards. It will first match against course codes, then short name, then original names.
Input:
canvas_ladok3_spreadsheet.py canvas_course_id
Add the "-T" flag to run in the Ladok test environment.
Output: outputs a file ('users_programs-COURSE_ID.xlsx) containing a spreadsheet of the users information
canvas_ladok3_spreadsheet.py 12162
canvas_ladok3_spreadsheet.py -t 'II2202 HT20-1'
ladok3_course_instance_to_spreadsheet.py
Purpose: Use the data in Ladok3 together with the data from Canvas to create a spreadsheet of students in a course instance and include their Canvas user_id (or "not in Canvas" if they do not have a Canvas user_id), name, Ladok3 Uid, program_code, program name, etc.
Note that the course_id can be given as a numeric value or a string which will be matched against the courses in the user's dashboard cards. It will first match against course codes, then short name, then original names.
Input:
ladok3_course_instance_to_spreadsheet.py course_code course_instance
or
ladok3_course_instance_to_spreadsheet.py canvas_course_id
or
./ladok3_course_instance_to_spreadsheet.py course_code
Optionally include their personnumber with the flag -p or --personnumbers
Add the "-T" flag to run in the Ladok test environment.
Output: outputs a file ('users_programs-instance-COURSE_INSTANCE.xlsx) containing a spreadsheet of the users information
# for II2202 the P1 instance in 2019 the course instance is 50287
ladok3_course_instance_to_spreadsheet.py II2202 50287
or
# Canvas course_id for II2202 in P1 is 20979
ladok3_course_instance_to_spreadsheet.py 20979
or
# P1P2 is a nickname on a dashboard card for II2202 duing P1 and P2
./ladok3_course_instance_to_spreadsheet.py P1P2
canvas_students_missing_integration_ids.py
Purpose: Use the data in a Canvas course room to create a spreadsheet of students in the course who are missing an integration ID.
Input:
canvas_students_missing_integration_ids.py canvas_course_id
Output: outputs a file ('users_without_integration_ids-COURSE_ID.xlsx) containing a spreadsheet of the users information
cl_user_info.py
Purpose: Use the data in a Canvas course room together with the data from Ladok3 to find information about a user.
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.
Add the "-k" or '--kthid' flag to get the KTHID (i.e., the 'sis_user_id) you need to specify a course_id for a course (where this user is a teacher or student) on the command line.
Add the "-T" flag to run in the Ladok test environment.
If you know the Ladok_id, i.e., the integration_id - then you do not need to specify a course_id.
The program can also take an argument in the form https://canvas.kth.se/courses/course_id/users/user_id
- this is the URL when you are on a user's page in a course.
Output:
from Canvas: sortable name, user_id, and integration_id
if you specified a course_id, you will also get KTHID and login_id
from Ladok: pnr (personnumber) and [program_code, program_name, specialization/track code, admissions info]
1 maintainer
Metadata
1 maintainer
Release files for ladok3 5.20
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ladok3-5.20.tar.gz | 186.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ladok3-5.20-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.8 MB
Release files / ladok3-5.20.tar.gz
| Download URL | ladok3-5.20.tar.gz |
|---|---|
| Size | 186.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c201d8adbb041d3539beeec990f55e76141589345227740756165e5fc705adba
|
|
BLAKE2b-256 checksum How to use checksums |
a17e0512b4a07638fa3e4c1daf31a21f5a93c561868cfa863ecab56e212e8f5f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.3 CPython/3.14.4 Linux/7.0.0-31-generic
|
Release files / ladok3-5.20-py3-none-any.whl
| Download URL | ladok3-5.20-py3-none-any.whl |
|---|---|
| Size | 2.6 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
82890a9ccf071ca6e762165595535c1079f379aed479e77fc1f069de5953907e
|
|
BLAKE2b-256 checksum How to use checksums |
3bb76a73b30ef2209f1826be6af06239f1178320c35acb62682f9835c8c2323f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.3 CPython/3.14.4 Linux/7.0.0-31-generic
|
Security for ladok3 5.20
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
