Version 1.0.1 - Docfix and QR method separate

README.rst

@@ -186,6 +186,9 @@ PyBankID can generate QR codes for you, and there is an example application in t
 `examples folder of the repo <https://github.com/hbldh/pybankid/tree/master/examples>`_ where a
 Flask application called ``qrdemo`` shows one way to do authentication with animated QR codes.
 
+The QR code content generation is done with the ``generate_qr_code_content`` method on the BankID Client instances, or diectly
+through the identically named method in ``bankid.qr`` module.
+
 Certificates
 ------------
 

bankid/__init__.py

@@ -23,8 +23,7 @@
 from bankid.certutils import create_bankid_test_server_cert_and_key
 from bankid.syncclient import BankIDClient
 from bankid.asyncclient import BankIDAsyncClient
-from bankid.baseclient import generate_qr_code_content
-
+from bankid.qr import generate_qr_code_content
 
 __all__ = [
     "BankIDClient",

bankid/baseclient.py

@@ -1,12 +1,9 @@
 import base64
 from datetime import datetime
-import hashlib
-import hmac
-from math import floor
-import time
 from typing import Tuple, Optional, Dict, Any
 from urllib.parse import urljoin
 
+from bankid.qr import generate_qr_code_content
 from bankid.certutils import resolve_cert_path
 
 
@@ -72,18 +69,3 @@ def _create_payload(
         if user_visible_data_format and user_visible_data_format == "simpleMarkdownV1":
             data["userVisibleDataFormat"] = "simpleMarkdownV1"
         return data
-
-
-def generate_qr_code_content(qr_start_token: str, start_t: [float, datetime], qr_start_secret: str) -> str:
-    """Given QR start token, time.time() or UTC datetime when initiated authentication call was made and the
-    QR start secret, calculate the current QR code content to display.
-    """
-    if isinstance(start_t, datetime):
-        start_t = start_t.timestamp()
-    elapsed_seconds_since_call = int(floor(time.time() - start_t))
-    qr_auth_code = hmac.new(
-        qr_start_secret.encode(),
-        msg=str(elapsed_seconds_since_call).encode(),
-        digestmod=hashlib.sha256,
-    ).hexdigest()
-    return f"bankid.{qr_start_token}.{elapsed_seconds_since_call}.{qr_auth_code}"

bankid/qr.py

@@ -0,0 +1,20 @@
+import hashlib
+import hmac
+import time
+from datetime import datetime
+from math import floor
+
+
+def generate_qr_code_content(qr_start_token: str, start_t: [float, datetime], qr_start_secret: str) -> str:
+    """Given QR start token, time.time() or UTC datetime when initiated authentication call was made and the
+    QR start secret, calculate the current QR code content to display.
+    """
+    if isinstance(start_t, datetime):
+        start_t = start_t.timestamp()
+    elapsed_seconds_since_call = int(floor(time.time() - start_t))
+    qr_auth_code = hmac.new(
+        qr_start_secret.encode(),
+        msg=str(elapsed_seconds_since_call).encode(),
+        digestmod=hashlib.sha256,
+    ).hexdigest()
+    return f"bankid.{qr_start_token}.{elapsed_seconds_since_call}.{qr_auth_code}"

docs/api_reference.rst

@@ -5,7 +5,7 @@ API Reference
 =============
 
 Base Client
-~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~
 
 .. automodule:: bankid.baseclient
    :members:
@@ -22,6 +22,12 @@ Asynchronous Client
 .. automodule:: bankid.asyncclient
    :members:
 
+QR Utils
+~~~~~~~~
+
+.. automodule:: bankid.qr
+   :members:
+
 Exceptions
 ~~~~~~~~~~
 .. automodule:: bankid.exceptions

docs/examples.rst

@@ -8,6 +8,9 @@ PyBankID can generate QR codes for you. There is an demo application in the
 `examples folder of the repo <https://github.com/hbldh/pybankid/tree/master/examples>`_ where a
 Flask application called ``qrdemo`` shows one way to do authentication with animated QR codes.
 
+The QR code content generation is done with the ``generate_qr_code_content`` method on the BankID Client instances, or diectly
+through the identically named method in ``bankid.qr`` module.
+
 Below follows the app's README file, for your convenience.
 
 QR Authentication Example