ladok3 4.17__tar.gz → 4.18__tar.gz

{ladok3-4.17 → ladok3-4.18}/LICENSE

@@ -2,7 +2,7 @@ MIT License
 
 Copyright (c) 2020 Alexander Baltatzis
 Copyright (c) 2020 Gerald Q. Maguire Jr.
-Copyright (c) 2021--2024 Daniel Bosk
+Copyright (c) 2021--2025 Daniel Bosk
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"),

{ladok3-4.17 → ladok3-4.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ladok3
-Version: 4.17
+Version: 4.18
 Summary: Python wrapper and CLI for the LADOK3 REST API.
 Home-page: https://github.com/dbosk/ladok3
 License: MIT
@@ -123,6 +123,33 @@ component_result.set_grade("P", "2021-03-15")
 component_result.finalize()
 ```
 
+A better way is to use the `load_credentials` function of the CLI.
+```python
+import ladok3
+import ladok3.cli
+
+ls = ladok3.LadokSession(*ladok3.cli.load_credentials())
+
+student = ls.get_student("123456-1234")
+# ...
+```
+
+An even better way is to reuse the stored session to use the already built 
+cache.
+```python
+import ladok3
+import ladok3.cli
+
+_, credentials = ladok3.cli.load_credentials()
+
+ls = ladok3.cli.restore_ladok_session(credentials)
+
+student = ls.get_student("123456-1234")
+# ...
+
+ladok3.cli.store_ladok_session(ls, credentials)
+```
+
 ## More documentation
 
 There are more detailed usage examples in the details documentation that can be 

{ladok3-4.17 → ladok3-4.18}/README.md

@@ -87,6 +87,33 @@ component_result.set_grade("P", "2021-03-15")
 component_result.finalize()
 ```
 
+A better way is to use the `load_credentials` function of the CLI.
+```python
+import ladok3
+import ladok3.cli
+
+ls = ladok3.LadokSession(*ladok3.cli.load_credentials())
+
+student = ls.get_student("123456-1234")
+# ...
+```
+
+An even better way is to reuse the stored session to use the already built 
+cache.
+```python
+import ladok3
+import ladok3.cli
+
+_, credentials = ladok3.cli.load_credentials()
+
+ls = ladok3.cli.restore_ladok_session(credentials)
+
+student = ls.get_student("123456-1234")
+# ...
+
+ladok3.cli.store_ladok_session(ls, credentials)
+```
+
 ## More documentation
 
 There are more detailed usage examples in the details documentation that can be 

{ladok3-4.17 → ladok3-4.18}/doc/Makefile

@@ -25,6 +25,8 @@ ladok3.pdf: ../examples/example_Student.py
 ladok3.pdf: ../examples/example_Course.py
 ladok3.pdf: ../examples/canvas2ladok.tex
 
+ladok3.pdf: didactic.sty
+
 ../%::
 	${MAKE} -C $(dir $@) $(notdir $@)
 
@@ -44,3 +46,5 @@ distclean:
 
 INCLUDE_MAKEFILES=../makefiles
 include ${INCLUDE_MAKEFILES}/tex.mk
+INCLUDE_DIDACTIC=./didactic
+include ${INCLUDE_DIDACTIC}/didactic.mk

{ladok3-4.17 → ladok3-4.18}/doc/ladok3.tex

@@ -1,14 +1,9 @@
-\documentclass[a4paper,oneside]{book}
-\newenvironment{abstract}{}{}
-\usepackage{abstract}
+\documentclass[a4paper,oneside]{memoir}
 \usepackage{noweb}
-% Needed to relax penalty for breaking code chunks across pages, otherwise 
-% there might be a lot of space following a code chunk.
-\def\nwendcode{\endtrivlist \endgroup}
-\let\nwdocspar=\smallbreak
+\noweboptions{breakcode,longchunks,longxref}
 
 \usepackage[hyphens]{url}
-\usepackage{hyperref}
+\usepackage[colorlinks]{hyperref}
 \usepackage{authblk}
 
 \input{preamble.tex}
@@ -39,7 +34,7 @@
 \end{abstract}
 \clearpage
 
-\tableofcontents
+\tableofcontents*
 \clearpage
 
 \mainmatter

{ladok3-4.17 → ladok3-4.18}/doc/preamble.tex

@@ -53,3 +53,4 @@
 \Crefname{question}{Question}{Questions}
 \creflabelformat{question}{#2\textup{#1}#3}
 
+\usepackage{didactic}

{ladok3-4.17 → ladok3-4.18}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ladok3"
-version = "4.17"
+version = "4.18"
 description = "Python wrapper and CLI for the LADOK3 REST API."
 authors = [
   "Daniel Bosk <dbosk@kth.se>",