ladok3 4.15__tar.gz → 4.17__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ladok3
-Version: 4.15
+Version: 4.17
 Summary: Python wrapper and CLI for the LADOK3 REST API.
 Home-page: https://github.com/dbosk/ladok3
 License: MIT
@@ -28,7 +28,7 @@ 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)
-Requires-Dist: weblogin (>=1.10,<2.0)
+Requires-Dist: weblogin (>=1.11,<2.0)
 Project-URL: Bug Tracker, https://github.com/dbosk/ladok3/issues
 Project-URL: Repository, https://github.com/dbosk/ladok3
 Project-URL: Releases, https://github.com/dbosk/ladok3/releases

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ladok3"
-version = "4.15"
+version = "4.17"
 description = "Python wrapper and CLI for the LADOK3 REST API."
 authors = [
   "Daniel Bosk <dbosk@kth.se>",
@@ -56,7 +56,7 @@ cryptography = "^41.0.3"
 keyring = "^24.2.0"
 requests = "^2.31.0"
 urllib3 = "^1.26.9"
-weblogin = "^1.10"
+weblogin = "^1.11"
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.1.3"

{ladok3-4.15 → ladok3-4.17}/src/ladok3/cli.nw

@@ -299,21 +299,17 @@ the user.
 Manages the user's LADOK login credentials. There are three ways to supply the 
 login credentials, in order of priority:
 
-1) Through the system keyring: Just run `ladok login` and you'll be asked to 
-   enter the credentials and they will be stored in the keyring. Note that for 
-   this to work on the WSL platform (and possibly on Windows), you need to 
-   install the `keyrings.alt` package: `python3 -m pip install keyrings.alt`.
+1) Through the environment: Just set the environment variables
 
-2) Through the environment: Just set the environment variables
+   a) LADOK_INST, the name of the institution, e.g. KTH Royal Institute of
+      Technology;
 
-  a) LADOK_INST, the name of the institution, e.g. KTH Royal Institute of 
-  Technology;
-  b) LADOK_VARS, a colon-separated list of environment variables, similarly to 
-  what's done in `ladok login` --- most don't need this, but can rather set
-  LADOK_USER (the username, e.g. dbosk@ug.kth.se) and
-  LADOK_PASS (the password) instead.
+   b) LADOK_VARS, a colon-separated list of environment variables, similarly to
+      what's done in `ladok login` --- most don't need this, but can rather set 
+      LADOK_USER (the username, e.g. dbosk@ug.kth.se) and LADOK_PASS (the 
+      password) instead.
 
-3) Through the configuration file: Just write
+2) Through the configuration file: Just write
 
       {{
         "institution": "the name of the university"
@@ -325,6 +321,17 @@ login credentials, in order of priority:
    option). (The keys 'username' and 'password' can be renamed to correspond to 
    the necessary values if the university login system uses other names.)
 
+3) Through the system keyring: Just run `ladok login` and you'll be asked to
+   enter the credentials and they will be stored in the keyring. Note that for 
+   this to work on the WSL platform (and possibly on Windows), you need to 
+   install the `keyrings.alt` package: `python3 -m pip install keyrings.alt`.
+
+The keyring is the most secure. However, sometimes one want to try different 
+credentials, so the environment should override the keyring. Also, on WSL the 
+keyring might require you to enter a password in the terminal---this is very 
+inconvenient in scripts. However, when logging in, we first try to store the 
+credentials in the keyring.
+
 <<add subparsers to subp>>=
 login_parser = subp.add_parser("login",
   help="Manage login credentials",
@@ -510,52 +517,17 @@ def load_credentials(filename="config.json"):
   can be passed to `LadokSession(instiution, credential dictionary)`.
   """
 
-  <<fetch vars from keyring>>
-  <<fetch username and password from keyring>>
   <<fetch institution from environment>>
   <<fetch username and password from environment>>
   <<fetch vars from environment>>
   <<fetch vars from config file>>
+  <<fetch vars from keyring>>
+  <<fetch username and password from keyring>>
 
   return None, None
 @
 
-First we try the newest format.
-We try to fetch the institution and vars from the keyring.
-
-Note that [[keyring]] returns [[None]] if the key doesn't exist, it doesn't 
-raise an exception.
-<<fetch vars from keyring>>=
-try:
-  institution = keyring.get_password("ladok3", "institution")
-  vars_keys = keyring.get_password("ladok3", "vars")
-
-  vars = {}
-  for key in vars_keys.split(";"):
-    value = keyring.get_password("ladok3", key)
-    if value:
-      vars[key] = value
-
-  if institution and vars:
-    return institution, vars
-except:
-  pass
-@
-
-However, if that fails, we fall back on the previous format, that only 
-supported KTH.
-<<fetch username and password from keyring>>=
-try:
-  institution = "KTH Royal Institute of Technology"
-  username = keyring.get_password("ladok3", "username")
-  password = keyring.get_password("ladok3", "password")
-  if username and password:
-    return institution, {"username": username, "password": password}
-except:
-  pass
-@
-
-Next in priority is to read from the environment.
+First in priority is to read from the environment.
 We try to read the institution.
 If that fails, we assume we're using the old format that only supported KTH.
 <<fetch institution from environment>>=
@@ -563,7 +535,6 @@ try:
   institution = os.environ["LADOK_INST"]
 except:
   institution = "KTH Royal Institute of Technology"
-
 <<fetch username and password from environment>>=
 try:
   vars = {
@@ -578,6 +549,8 @@ except:
 
 If we couldn't read the old [[LADOK_USER]] and [[LADOK_PASS]], we try to read 
 the [[vars]] from the environment using [[LADOK_VARS]].
+Note that we need the [[institution]] to be set from [[LADOK_INST]] above for 
+this.
 <<fetch vars from environment>>=
 try:
   vars_keys = os.environ["LADOK_VARS"]
@@ -605,8 +578,7 @@ it doesn't exist.
 warn(f"Variable {key} not set, ignoring.")
 @
 
-If none of the above worked, the last resort is to try to read the 
-configuration file.
+If none of the above worked, we try the config file next.
 We pop the institution from the configuration file (a dictionary), because then 
 the remaining entries will be used as [[vars]].
 <<fetch vars from config file>>=
@@ -621,6 +593,40 @@ except:
   pass
 @
 
+Lastly, if nothing else worked, we try to fetch the institution and vars from 
+the keyring.
+Note that [[keyring]] returns [[None]] if the key doesn't exist, it doesn't 
+raise an exception.
+<<fetch vars from keyring>>=
+try:
+  institution = keyring.get_password("ladok3", "institution")
+  vars_keys = keyring.get_password("ladok3", "vars")
+
+  vars = {}
+  for key in vars_keys.split(";"):
+    value = keyring.get_password("ladok3", key)
+    if value:
+      vars[key] = value
+
+  if institution and vars:
+    return institution, vars
+except:
+  pass
+@
+
+However, if that fails, we fall back on the previous format, that only 
+supported KTH.
+<<fetch username and password from keyring>>=
+try:
+  institution = "KTH Royal Institute of Technology"
+  username = keyring.get_password("ladok3", "username")
+  password = keyring.get_password("ladok3", "password")
+  if username and password:
+    return institution, {"username": username, "password": password}
+except:
+  pass
+@
+
 
 \section{Managing the cache: the \texttt{cache} command and subcommands}