ref: improve logging and docstrings

CHANGELOG

@@ -1,3 +1,6 @@
+0.14.2
+ - docs: improve doc strings
+ - ref: improve logging
 0.14.1
  - setup: fix build pipeline (remove editable install)
 0.14.0

dcoraid/api/ckan_api.py

@@ -35,7 +35,7 @@ class CKANAPI:
     def __init__(self,
                  server: str,
                  api_key: str | None = "",
-                 ssl_verify: bool = True,
+                 ssl_verify: bool | str = True,
                  check_ckan_version: bool = True,
                  caching: bool | str | pathlib.Path = True):
         """User-convenient interface to the CKAN API
@@ -46,8 +46,9 @@ def __init__(self,
             Server to which to connect to, e.g. dcor.mpl.mpg.de
         api_key: str
             API token to use for accessing private datasets
-        ssl_verify: bool
-            Whether to verify SSL connections
+        ssl_verify: bool or str
+            Either a boolean indicating whether SSL certificates should be
+            verified or a path to an SSL certificate for certificate pinning.
         check_ckan_version: bool
             Whether to check for the proper CKAN version
         caching: bool or str or pathlib.Path

dcoraid/gui/api.py

@@ -1,4 +1,5 @@
 import atexit
+import logging
 import os
 import pathlib
 import shutil
@@ -13,6 +14,8 @@
 #: to `None` which means DCOR-Aid decides depending on where it is.
 _SSL_VERIFY = False if _disable_ssl else None
 
+logger = logging.getLogger(__name__)
+
 
 def get_ckan_api(public=False):
     """Convenience function for obtaining CKANAPI instance from settings"""
@@ -41,4 +44,5 @@ def setup_certificate_file():
             _SSL_VERIFY = str(cert_path)
         else:
             _SSL_VERIFY = True
+    logger.info(f"SSL verification: {_SSL_VERIFY}")
     return _SSL_VERIFY