logging docu & logger_config() rename

Author: Canicula98

docs/index.rst

@@ -12,6 +12,7 @@ dataClay
    advanced-usage
    telemetry
    hpc-tracing
+   logging
    examples/index
 
 .. toctree::

docs/logging.rst

@@ -0,0 +1,43 @@
+=======
+Logging
+=======
+
+DataClay offers logging to allow code debugging and information collection. 
+
+When dataclay is imported, the logging is first initialized with a basic configuration in the config.py file:
+
+.. code-block:: python
+    :caption: config.py
+
+    ...
+
+    class Settings(BaseSettings):
+
+    ...
+
+        loglevel: Annotated[str, StringConstraints(strip_whitespace=True, to_upper=True)] = "INFO"
+
+    ...
+
+    settings = Settings()
+
+    ...
+
+
+    def logger_config(**kwargs):
+        logging.basicConfig(**kwargs)
+
+
+    logger_config(level=settings.loglevel)
+
+
+
+If the user wants to configure its own logging, it can be done by importing the logging library and modifying 
+the basicConfig. When client.start() function is called, then logger_config() is executed again, and if the argument
+"force" is True then the logging configuration is overwritten.
+
+.. warning::
+    When modifying the basicConfig remember that the **force=True** parameter is mandatory. Otherwise, this new 
+    configuration will be obviated.
+
+An example is available in `GitHub <https://github.com/bsc-dom/dataclay/tree/main/examples/client-logger-config>`_

src/dataclay/client/api.py

@@ -18,7 +18,7 @@
 from dataclay.config import (
     ClientSettings,
     get_runtime,
-    loggerConfig,
+    logger_config,
     session_var,
     set_runtime,
     settings,
@@ -170,7 +170,7 @@ def __init__(
     def start(self):
         """Start the client runtime"""
 
-        loggerConfig(level=settings.loglevel)
+        logger_config(level=settings.loglevel)
 
         if self.is_active:
             logger.warning("Client already active. Ignoring")

src/dataclay/config.py

@@ -232,8 +232,8 @@ def set_runtime(new_runtime: Union[ClientRuntime, BackendRuntime]):
     current_runtime = new_runtime
 
 
-def loggerConfig(**kwargs):
+def logger_config(**kwargs):
     logging.basicConfig(**kwargs)
 
 
-loggerConfig(level=settings.loglevel)
+logger_config(level=settings.loglevel)