Merge pull request #18 from scailable/develop

Merge latest development version (0.1.1) with master.

Author: robinvanemden

.gitignore

@@ -138,4 +138,5 @@ dmypy.json
 .idea/
 
 # User credentials
-.creds.json
+.creds.json
+temp.py

MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE
+recursive-include sclblpy *.json

README.md

@@ -1,5 +1,7 @@
 """
 The sclblpy package allows users to upload, monitor, and administer models and REST endpoints directly from python.
 """
-from .main import upload, endpoints, delete_endpoint, remove_credentials
+from .main import upload, endpoints, delete_endpoint, remove_credentials, list_models, stop_print, start_print, \
+    _set_toolchain_URL, _set_admin_URL
+from .version import __version__
 

sclblpy/__init__.py

@@ -2,5 +2,5 @@
 # > python sclblpy
 # from terminal.
 if __name__ == '__main__':
-    print("The sclblpy package does not have any command line options.")
+    print("The sclblpy package currently does not have any command line options.")
     print("Please import the package into your python project and work from there.")

sclblpy/__main__.py

@@ -1,4 +1,4 @@
-# _bundle.py contains private methods for gzip bundling of object
+# _bundle.py contains private methods for gzip bundling of the model object
 import gzip
 import pickle
 import os
@@ -7,49 +7,51 @@
 import sclblpy._globals as glob
 
 
-def _gzip_save(object, filename: str=glob.BUNDLE_NAME, _verbose=False):
+def _gzip_save(object, filename: str=glob.GZIP_BUNDLE):
     """Saves a compressed object to disk.
 
     Function is used to pickle and gzip an sclblpy model object as created
     by the upload() function. This package is send to the toolchain.
 
     Args:
         object: A dictionary containing all the information to be send.
-        filename: a string stating where to store the .zip file. Default glob.BUNDLE_NAME
-        _verbose: Bool indicating whether feedback should be printed. Default False.
+        filename: a string stating where to store the .zip file. Default glob.GZIP_BUNDLE
 
     Returns:
+        True if the bundle is successfully saved, False if not.
 
-    Raises:
+    Raises (in debug mode):
           ModelBundleError if unable to store the model bundle.
 
     """
     try:
+        os.makedirs(os.path.dirname(filename), exist_ok=True)  # create the folder if it does not exists.
         fp = gzip.open(filename, 'wb')
-        pickle.dump(object, fp)
+        pickle.dump(object, fp, protocol=4)  # protocol = 4 is python 3.4 or higher
         fp.close()
-        if _verbose:
-            print("File successfully stored.")
+        if glob.DEBUG:
+            print("Bundle message: File successfully stored.")
+        return True
     except Exception as e:
-        if _verbose:
-            print("Exception: " + str(e))
-        raise ModelBundleError("Unable to pickle and gzip your model.")
+        if glob.DEBUG:
+            print("Bundle exception: " + str(e))
+            raise ModelBundleError("Bundle error: Unable to pickle and gzip your model.")
+        return False
 
-    return
 
-
-def _gzip_load(filename: str=glob.BUNDLE_NAME, _verbose=True):
+def _gzip_load(filename: str=glob.GZIP_BUNDLE):
     """Loads a compressed object from disk.
 
     Currently not used in the sclblpy package but syntax should be used on the toolchain side.
 
     Args:
-        filename: Name of the gzipped pickle. Default "temp_sclbl_mod.gzip".
-        _verbose: Bool indicating whether feedback should be printed. Default True.
+        filename: Name of the gzipped pickle. Default glob.GZIP_BUNDLE.
+
     Returns:
         obj: A dictonary containing the unpickled and unzipped contents of the file. Empty dict if unable to open.
+            False otherwise.
 
-    Raises:
+    Raises (in debug mode):
         ModelBundleError if fails.
 
     """
@@ -59,47 +61,52 @@ def _gzip_load(filename: str=glob.BUNDLE_NAME, _verbose=True):
             fp = gzip.open(filename, 'rb')
             obj = pickle.load(fp)
             fp.close()
-            if _verbose:
-                print("Model bundle successfully loaded.")
+            if glob.DEBUG:
+                print("Bundle message: Model bundle successfully loaded.")
         else:
-            if _verbose:
-                print("Model bundle not found.")
+            if glob.DEBUG:
+                print("Bundle message: Model bundle not found.")
+            return False
     except Exception as e:
-        if _verbose:
-            print("Exception: " + str(e))
-        raise ModelBundleError("Unable to load model bundle.")
+        if glob.DEBUG:
+            print("Bundle exception: " + str(e))
+            raise ModelBundleError("Bundle error: Unable to load model bundle.")
+        return False
 
     return obj
 
 
-def _gzip_delete(filename:str =glob.BUNDLE_NAME, _verbose=False):
+def _gzip_delete(filename:str =glob.GZIP_BUNDLE):
     """Deletes a file from user machine.
 
     Args:
-        filename: Str name of the file to delete, default: temp_sclbl_mod.gzip.
-        _verbose: Bool indicating whether feedback should be printed. Default False.
+        filename: Str name of the file to delete. Default: glob.GZIP_BUNDLE.
 
     Returns:
+        True if all is well, False otherwise.
 
-    Raises:
+    Raises (in debug mode):
         ModelBundleError if fails.
 
     """
 
     try:
         if os.path.exists(filename):
             os.remove(filename)
-            if _verbose:
-                print("Deleted gzipped model bundle.")
+            if glob.DEBUG:
+                print("Bundle message: Deleted gzipped model bundle.")
         else:
-            if _verbose:
-                print("File not found.")
+            if glob.DEBUG:
+                print("Bundle message: File not found.")
+            return False
     except Exception as e:
-        print("Exception: " + str(e))
-        raise ModelBundleError("Unable to delete file.")
+        if glob.DEBUG:
+            print("Bundle message: exception: " + str(e))
+            raise ModelBundleError("Bundle error: Unable to delete file.")
+        return False
 
-    return
+    return True
 
 
 if __name__ == '__main__':
-    print("No command line options yet for _bundle.py.")
+    print("No command line options for _bundle.py.")

sclblpy/_bundle.py

@@ -1,20 +1,28 @@
 # Global variables for the sclblpy package.
 import os
+from sclblpy.appdirs import AppDirs
 
-PKG_NAME: str = "sclblpy_v_0.01"
+# servers:
+USER_MANAGER_URL: str = "https://admin.sclbl.net"  # Location of the user manager.
+TOOLCHAIN_URL: str = "https://toolchain.sclbl.net"  # Location of the toolchain server.
 
-USER_MANAGER_URL: str = "http://localhost:8008"  # Location of the user manager.
-TOOLCHAIN_URL: str = "http://localhost:8001"  # Location of the toolchain server.
+# control printing:
+SILENT: bool = False  # Boolean indicating whether user feedback should be suppressed.
+DEBUG: bool = False  # Boolean indicating whether using the package in debug mode; if so, it will raise exceptions.
 
+# Storage locations:
+dirs = AppDirs("sclblpy", "sclbl")
+USER_CREDENTIALS: str = dirs.user_config_dir + "/.creds.json"  # Location of json file to store user credentials
+GZIP_BUNDLE: str = dirs.user_data_dir + "/model_bundle.gzip"  # Location where a save model is (temporarily) stored
+MODELS_JSON: str = os.path.dirname(os.path.realpath(__file__)) + "/supported_models.json"  # Location of the json with supported models
+
+# JWT necessities:
 JWT_TOKEN: str = ""  # JWT token.
 JWT_USER_ID: str = ""  # Scailable user id.
 JWT_TIMESTAMP: float = 0.0  # Timestamp in seconds.
 
-USER_CREDENTIALS_FOLDER: str = ""  # Location where user credentials are stored.
-
-CURRENT_FOLDER: str = os.path.dirname(os.path.realpath(__file__))  # Folder where the module is running.
+# Available models:
 SUPPORTED_MODELS: dict = {}  # List of supported models.
-BUNDLE_NAME: str = "temp_sclbl_mod_bundle.gzip"
 
 
 if __name__ == '__main__':