Merge pull request #152 from PythonPredictions/151-include-turorial-while-importing

#151 add tutorial while importing

Author: patrickleonardy

cobra/__init__.py

@@ -1 +1,7 @@
-from .version import __version__
+from .version import __version__
+from cobra.utils import log_tutorial
+import logging
+
+logging.basicConfig(level=logging.INFO, format="%(message)s")
+
+log_tutorial()

cobra/preprocessing/preprocessor.py

@@ -223,7 +223,7 @@ def from_pipeline(cls, pipeline: dict):
             target_encoder,
             is_fitted=pipeline["_is_fitted"],
         )
-
+        
     def get_continuous_and_discrete_columns(
         self, df: pd.DataFrame, id_col_name: str, target_column_name: str
     ) -> tuple:

cobra/utils.py

@@ -1,7 +1,24 @@
+import logging
+
+# logger = logging.getLogger(__name__)
+# logger.setLevel(logging.INFO)
+# logger.addHandler(logging.Handler())
+
+
 def clean_predictor_name(predictor_name: str) -> str:
     """Strip the redundant suffix (e.g. "_enc" or "_bin") off from the end
     of the predictor name to return a clean version of the predictor
     """
-    return (predictor_name.replace("_enc", "")
-                          .replace("_bin", "")
-                          .replace("_processed", ""))
+    return (
+        predictor_name.replace("_enc", "").replace("_bin", "").replace("_processed", "")
+    )
+
+
+def log_tutorial() -> None:
+    logging.info(
+        """
+    Hi, welcome to Cobra!
+    You can find some tutorials that explain the functioning of cobra on the PythonPredictions GitHub:
+    https://github.com/PythonPredictions/cobra/tree/master/tutorials
+        """
+    )

tests/general_tests/test_tutorial.py

@@ -0,0 +1,12 @@
+import logging
+
+
+def test_log_tutorial(caplog):
+    from cobra.utils import log_tutorial
+
+    with caplog.at_level(logging.DEBUG):
+        log_tutorial()
+    assert (
+        "https://github.com/PythonPredictions/cobra/tree/master/tutorials"
+        in caplog.text
+    )