Merge pull request #40 from credo-ai/release/0.1.3

Release/0.1.3

README.md

@@ -26,3 +26,14 @@ pip install credoai-connect
 ## Documentation
 
 Documentation is hosted by [readthedocs](https://credoai-connect.readthedocs.io/en/stable/).
+
+
+## Logging
+Logging defaults to stdout. In order to collect all logging information into a specific file,
+set the desired location to the environment variable `CREDO_CONNECT_LOG_PATH`. 
+
+
+
+> **Warning**
+> Make sure the destination has write permissions, otherwise you will get a `PermissionError` at the moment you
+> attempt library import.

connect/_version.py

@@ -2,4 +2,4 @@
 # 1) we don't load dependencies by storing it in __init__.py
 # 2) we can import it in setup.py for the same reason
 # 3) we can import it into your module module
-__version__ = "0.1.2"
+__version__ = "0.1.3"

connect/utils/logging.py

@@ -2,6 +2,7 @@
 from io import StringIO
 from logging import FileHandler, Formatter, Handler, StreamHandler, getLogger
 from os.path import join
+from os import getenv
 from sys import stdout
 
 
@@ -67,9 +68,10 @@ def setup_file(self):
         self.logger.addHandler(file_handler)
 
 
-def setup_logger(name="connect", path=None, record_stream=False, logging_level="INFO"):
+def setup_logger(name="connect", record_stream=False, logging_level="INFO"):
+    path = getenv("CREDO_CONNECT_LOG_PATH")
     tmp = Logger(name, path, record_stream, logging_level)
     return tmp.logger, tmp.stream
 
 
-global_logger, global_tail = setup_logger(path=".")
+global_logger, global_tail = setup_logger()