Merge branch 'release/v0.1.5'

Author: robinvanemden

sclblpy/__init__.py

@@ -13,3 +13,9 @@
     start_print, _set_toolchain_URL, _set_usermanager_URL, _set_taskmanager_URL
 from .version import __version__
 
+# Simple welcome message:
+print("\n*** Thanks for importing sclblpy! ***")
+print("You can use the 'upload()' function to upload your models.")
+print("To inspect your currently uploaded models, use `endpoints()`.")
+print("Check the docs at https://pypi.org/project/sclblpy/ for more info. \n")
+

sclblpy/_globals.py

@@ -25,6 +25,9 @@
 # Available models:
 SUPPORTED_MODELS: dict = {}  # List of supported models.
 
+# Pretty printing of example:
+EXAMPLE__BASE_URL: str = "https://admin.sclbl.net/run.html"
+
 
 if __name__ == '__main__':
     print("No command line options available for _globals.py.")

sclblpy/_jwt.py

@@ -130,10 +130,10 @@ def _sign_in(username: str, password: str, _remove_file=True) -> bool:
             return False
 
         if result.get("error") is not None:
+            if not glob.SILENT:
+                print("JWT authentication error: The server generated an error: " + result.get("error"))
             if _remove_file:
                 _remove_credentials()  # Removing user credentials since they are not right
-            if not glob.SILENT:
-                print("JWT error: the server generated an error: " + result.get("error"))
             if glob.DEBUG:
                 raise LoginError(result.get("JWT server error: " + result.get("error")))
             return False
@@ -305,7 +305,7 @@ def _remove_credentials():
             return False
         if not glob.SILENT:
             print("Your stored user credentials have been removed. \n"
-                  "Please re-enter your username and password next time you try to upload a model.")
+                  "You will have to re-enter your username and password next time.")
 
         return True
     else:

sclblpy/main.py

@@ -1,6 +1,7 @@
 # File contains all public methods of the scblpy package
 import json
 import sys
+import urllib
 
 import requests
 
@@ -198,7 +199,10 @@ def upload(mod, feature_vector, docs={}, email=True, _keep=False) -> bool:
 
         # user feedback:
         if not glob.SILENT:
-            print("Your model was successfully uploaded. \n")
+            print("Your model was successfully uploaded to Scailable!")
+            print("NOTE: After transpiling, we will send you an email and your model will be available at "
+                  "https://admin.sclbl.net.")
+            print("Or, alternatively, you can use the 'endpoints()' function to list all your uploaded models. \n")
 
         # remove bundle:
         if not _keep:
@@ -643,8 +647,7 @@ def endpoints(_verbose=True) -> dict:
         result = json.loads(response.text)
     except Exception as e:
         if not glob.SILENT:
-            print("We were unable retrieve your endpoints. \n"
-                  "Please try again later.")
+            print("We were unable retrieve your endpoints.")
         if glob.DEBUG:
             raise UserManagerError("Unable to retrieve endpoints. " + str(e))
         return False
@@ -653,10 +656,27 @@ def endpoints(_verbose=True) -> dict:
     if _verbose and not glob.SILENT:
         if not result:
             print("You currently do not own any active endpoints.")
+            print("\nNeed help getting started?")
+            print(" - See the sclblpy docs at https://pypi.org/project/sclblpy/.")
+            print(" - See our getting started tutorial at "
+                  "https://github.com/scailable/sclbl-tutorials/tree/master/sclbl-101-getting-started.")
+            print(" - Or, login to your admin at https://admin.sclbl.net. \n")
+            print("NOTE: if you have just uploaded a model, please check your email; we will let you know when its "
+                  "available!\n")
         else:
-            print("You currently own the following endpoints:")
+            # Pretty printing of list
+            baseUrl = glob.EXAMPLE__BASE_URL
+            i = 1
+            print("You currently own the following endpoints:\n")
             for key in result:
-                print('Name: {}, cfid: {}.'.format(key['name'], key['cfid']))
+                url = baseUrl + "?cfid=" + key['cfid']
+                url += "&exin=" + urllib.parse.quote(key['exampleinput'])
+
+                print('  {}: {}, \n'
+                      '   - cfid: {} \n'
+                      '   - example: {} \n'.format(i, key['name'], key['cfid'], url))
+                i = i+1
+            print("Login at https://admin.sclbl.net to administer your endpoints and see integration examples.\n")
 
     return result
 

sclblpy/version.py

@@ -1,2 +1,2 @@
 # Central place for version numbering:
-__version__ = "0.1.4"
+__version__  = "0.1.5"

test/test_main.py

@@ -170,6 +170,11 @@ def test_user_utils():
     print(glob.TOOLCHAIN_URL)
     print(glob.TASK_MANAGER_URL)
 
+    #endpoints()
+    #test_upload()
+    #endpoints()
+    #exit()
+
     if not PRINTING:
         stop_print()