ivoryos 1.3.3__tar.gz → 1.3.5a0__tar.gz

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ivoryos
-Version: 1.3.3
+Version: 1.3.5a0
 Summary: an open-source Python package enabling Self-Driving Labs (SDLs) interoperability
 Author-email: Ivory Zhang <ivoryzhang@chem.ubc.ca>
 License: MIT
@@ -28,7 +28,8 @@ Dynamic: license-file
 [![YouTube](https://img.shields.io/badge/YouTube-tutorial-red?logo=youtube)](https://youtu.be/dFfJv9I2-1g)
 [![YouTube](https://img.shields.io/badge/YouTube-demo-red?logo=youtube)](https://youtu.be/flr5ydiE96s)
 [![Published](https://img.shields.io/badge/Nature_Comm.-paper-blue)](https://www.nature.com/articles/s41467-025-60514-w)
-[![Discord](https://img.shields.io/discord/1313641159356059770?label=Discord&logo=discord&color=5865F2)](https://discord.gg/AX5P9EdGVX)
+
+[//]: # ([![Discord]&#40;https://img.shields.io/discord/1313641159356059770?label=Discord&logo=discord&color=5865F2&#41;]&#40;https://discord.gg/AX5P9EdGVX&#41;)
 
 ![](https://gitlab.com/heingroup/ivoryos/raw/main/docs/source/_static/ivoryos.png)
 # ivoryOS: interoperable Web UI for self-driving laboratories (SDLs)
@@ -101,11 +102,14 @@ pip install -e .
 ## Quick start
 In your SDL script, 
 ```python
+my_robot = Robot()
+
 import ivoryos
 
 ivoryos.run(__name__)
 ```
-Login: Create an account (local DB, bcrypt password)
+You can now access the web UI at http://127.0.0.1:8000,
+create an account, login, and start designing workflows!
 
 ----
 ## Features
@@ -127,6 +131,28 @@ Add single or multiple loggers:
 ivoryos.run(__name__, logger="logger name")
 ivoryos.run(__name__, logger=["logger 1", "logger 2"])
 ```
+### Human-in-the-loop
+Add single or multiple notification handlers for `pause` feature in flow control:
+```python
+
+def slack_bot(msg: str = "Hi"):
+    """
+    a function that can be used as a notification handler function("msg")
+    :param msg: message to send
+    """
+    from slack_sdk import WebClient
+
+    slack_token = "your slack token"
+    client = WebClient(token=slack_token)
+
+    my_user_id = "your user id"  # replace with your actual Slack user ID
+
+    client.chat_postMessage(channel=my_user_id, text=msg)
+
+import ivoryos
+ivoryos.run(__name__, notification_handler=slack_bot)
+```
+
 ### Directory Structure
 
 Created automatically on first run:
@@ -152,11 +178,10 @@ ivoryos.run(__name__)
 
 ## Roadmap
 
-- [x] Allow plugin pages ✅  
-- [x] pause, resume, abort current and pending workflows ✅
 - [ ] dropdown input 
 - [ ] snapshot version control
 - [ ] optimizer-agnostic
+- [ ] prefect compatibility
 - [ ] check batch-config file compatibility
 
 ---
@@ -198,4 +223,4 @@ For an additional perspective related to the development of the tool, please see
 ```
 ---
 ## Acknowledgements
-Authors acknowledge Telescope Innovations Corp., Hein Lab members for their valuable suggestions and contributions.
+Authors acknowledge Telescope Innovations Corp., UBC Hein Lab, and Acceleration Consortium members for their valuable suggestions and contributions.

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/README.md

@@ -4,7 +4,8 @@
 [![YouTube](https://img.shields.io/badge/YouTube-tutorial-red?logo=youtube)](https://youtu.be/dFfJv9I2-1g)
 [![YouTube](https://img.shields.io/badge/YouTube-demo-red?logo=youtube)](https://youtu.be/flr5ydiE96s)
 [![Published](https://img.shields.io/badge/Nature_Comm.-paper-blue)](https://www.nature.com/articles/s41467-025-60514-w)
-[![Discord](https://img.shields.io/discord/1313641159356059770?label=Discord&logo=discord&color=5865F2)](https://discord.gg/AX5P9EdGVX)
+
+[//]: # ([![Discord](https://img.shields.io/discord/1313641159356059770?label=Discord&logo=discord&color=5865F2)](https://discord.gg/AX5P9EdGVX))
 
 ![](https://gitlab.com/heingroup/ivoryos/raw/main/docs/source/_static/ivoryos.png)
 # ivoryOS: interoperable Web UI for self-driving laboratories (SDLs)
@@ -77,11 +78,14 @@ pip install -e .
 ## Quick start
 In your SDL script, 
 ```python
+my_robot = Robot()
+
 import ivoryos
 
 ivoryos.run(__name__)
 ```
-Login: Create an account (local DB, bcrypt password)
+You can now access the web UI at http://127.0.0.1:8000,
+create an account, login, and start designing workflows!
 
 ----
 ## Features
@@ -103,6 +107,28 @@ Add single or multiple loggers:
 ivoryos.run(__name__, logger="logger name")
 ivoryos.run(__name__, logger=["logger 1", "logger 2"])
 ```
+### Human-in-the-loop
+Add single or multiple notification handlers for `pause` feature in flow control:
+```python
+
+def slack_bot(msg: str = "Hi"):
+    """
+    a function that can be used as a notification handler function("msg")
+    :param msg: message to send
+    """
+    from slack_sdk import WebClient
+
+    slack_token = "your slack token"
+    client = WebClient(token=slack_token)
+
+    my_user_id = "your user id"  # replace with your actual Slack user ID
+
+    client.chat_postMessage(channel=my_user_id, text=msg)
+
+import ivoryos
+ivoryos.run(__name__, notification_handler=slack_bot)
+```
+
 ### Directory Structure
 
 Created automatically on first run:
@@ -128,11 +154,10 @@ ivoryos.run(__name__)
 
 ## Roadmap
 
-- [x] Allow plugin pages ✅  
-- [x] pause, resume, abort current and pending workflows ✅
 - [ ] dropdown input 
 - [ ] snapshot version control
 - [ ] optimizer-agnostic
+- [ ] prefect compatibility
 - [ ] check batch-config file compatibility
 
 ---
@@ -174,4 +199,4 @@ For an additional perspective related to the development of the tool, please see
 ```
 ---
 ## Acknowledgements
-Authors acknowledge Telescope Innovations Corp., Hein Lab members for their valuable suggestions and contributions.
+Authors acknowledge Telescope Innovations Corp., UBC Hein Lab, and Acceleration Consortium members for their valuable suggestions and contributions.

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/ivoryos/app.py

@@ -41,7 +41,8 @@ def reset_old_schema(engine, db_dir):
     old_workflow_run = 'workflow_runs' in tables
     old_workflow_step = 'workflow_steps' in tables
 
-    if not has_workflow_phase:
+    # v1.3.4 only delete and backup when there is runs but no phases
+    if not has_workflow_phase and old_workflow_run:
         print("⚠️ Old workflow database detected! All previous workflows have been reset to support the new schema.")
         # Backup old DB
         db_path = os.path.join(db_dir, "ivoryos.db")

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/ivoryos/routes/control/control.py

@@ -23,7 +23,7 @@ control.register_blueprint(control_temp)
 @control.route("/", strict_slashes=False, methods=["GET", "POST"])
 @control.route("/<string:instrument>", strict_slashes=False, methods=["GET", "POST"])
 @login_required
-def deck_controllers(instrument: str = None):
+async def deck_controllers(instrument: str = None):
     """
     .. :quickref: Direct Control; device (instruments) and methods
 
@@ -82,7 +82,7 @@ def deck_controllers(instrument: str = None):
 
         wait = str(payload.get("hidden_wait", "true")).lower() == "true"
 
-        output = runner.run_single_step(
+        output = await runner.run_single_step(
             component=instrument, method=method_name, kwargs=kwargs, wait=wait,
             current_app=current_app._get_current_object()
         )

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/ivoryos/routes/design/design.py

@@ -316,6 +316,7 @@ def methods_handler(instrument: str = ''):
     msg = ""
     request.form
     if "hidden_name" in request.form:
+        deck_snapshot = global_config.deck_snapshot
         method_name = request.form.get("hidden_name", None)
         form = forms.get(method_name) if forms else None
         insert_position = request.form.get("drop_target_id", None)
@@ -334,7 +335,9 @@ def methods_handler(instrument: str = ''):
                 action = {"instrument": instrument, "action": function_name,
                           "args": kwargs,
                           "return": save_data,
-                          'arg_types': primitive_arg_types}
+                          'arg_types': primitive_arg_types,
+                          "coroutine": deck_snapshot[instrument][function_name].get("coroutine", False) if deck_snapshot else False,
+                          }
                 script.add_action(action=action, insert_position=insert_position)
             else:
                 msg = [f"{field}: {', '.join(messages)}" for field, messages in form.errors.items()]

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/ivoryos/server.py

@@ -49,6 +49,7 @@ def run(module=None, host="0.0.0.0", port=None, debug=None, llm_server=None, mod
         enable_design: bool = True,
         blueprint_plugins: Union[list, Blueprint] = [],
         exclude_names: list = [],
+        notification_handler=None,
         ):
     """
     Start ivoryOS app server.
@@ -65,6 +66,7 @@ def run(module=None, host="0.0.0.0", port=None, debug=None, llm_server=None, mod
     :param enable_design: enable design canvas, database and workflow execution
     :param blueprint_plugins: Union[list[Blueprint], Blueprint] custom Blueprint pages
     :param exclude_names: list[str] module names to exclude from parsing
+    :param notification_handler: notification handler function
     """
     app = create_app(config_class=config or get_config())  # Create app instance using factory function
 
@@ -113,11 +115,33 @@ def run(module=None, host="0.0.0.0", port=None, debug=None, llm_server=None, mod
                                        output_path=app.config["OUTPUT_FOLDER"] if module is not None else None)
     else:
         app.config["ENABLE_LLM"] = False
-    if logger and type(logger) is str:
-        utils.start_logger(socketio, log_filename=logger_path, logger_name=logger)
-    elif type(logger) is list:
-        for log in logger:
-            utils.start_logger(socketio, log_filename=logger_path, logger_name=log)
+
+
+    # --- Logger registration ---
+    if logger:
+        if isinstance(logger, str):
+            logger = [logger]  # convert single logger to list
+        elif not isinstance(logger, list):
+            raise TypeError("logger must be a string or a list of strings.")
+
+        for log_name in logger:
+            utils.start_logger(socketio, log_filename=logger_path, logger_name=log_name)
+
+    # --- Notification handler registration ---
+    if notification_handler:
+
+        # make it a list if a single function is passed
+        if callable(notification_handler):
+            notification_handler = [notification_handler]
+
+        if not isinstance(notification_handler, list):
+            raise ValueError("notification_handlers must be a callable or a list of callables.")
+
+        # validate all items are callable
+        for handler in notification_handler:
+            if not callable(handler):
+                raise TypeError(f"Handler {handler} is not callable.")
+            global_config.register_notification(handler)
 
     # TODO in case Python 3.12 or higher doesn't log URL
     # if sys.version_info >= (3, 12):
@@ -129,23 +153,6 @@ def run(module=None, host="0.0.0.0", port=None, debug=None, llm_server=None, mod
     # return app
 
 
-# def load_installed_plugins(app, socketio):
-#     """
-#     Dynamically load installed plugins and attach Flask-SocketIO.
-#     """
-#     plugin_names = []
-#     for entry_point in entry_points().get("ivoryos.plugins", []):
-#         plugin = entry_point.load()
-#
-#         # If the plugin has an `init_socketio()` function, pass socketio
-#         if hasattr(plugin, 'init_socketio'):
-#             plugin.init_socketio(socketio)
-#
-#         plugin_names.append(entry_point.name)
-#         app.register_blueprint(getattr(plugin, entry_point.name), url_prefix=f"{url_prefix}/{entry_point.name}")
-#
-#     return plugin_names
-
 
 def load_plugins(blueprints: Union[list, Blueprint], app, socketio):
     """

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/ivoryos/utils/db_models.py

@@ -434,14 +434,21 @@ class Script(db.Model):
         :return: A dict containing script types as keys and lists of function body lines as values.
         """
         line_collection = {}
+
         for stype, func_str in exec_str_collection.items():
             if func_str:
                 module = ast.parse(func_str)
-                func_def = next(node for node in module.body if isinstance(node, ast.FunctionDef))
 
-                # Extract function body as source lines
-                line_collection[stype] = [ast_unparse(node) for node in func_def.body if not isinstance(node, ast.Return)]
-                # print(line_collection[stype])
+                # Find the first function (regular or async)
+                func_def = next(
+                    node for node in module.body
+                    if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef))
+                )
+
+                # Extract function body as source lines, skipping 'return' nodes
+                line_collection[stype] = [
+                    ast_unparse(node) for node in func_def.body if not isinstance(node, ast.Return)
+                ]
         return line_collection
 
     def compile(self, script_path=None):
@@ -459,7 +466,8 @@ class Script(db.Model):
 
         for i in self.stypes:
             if self.script_dict[i]:
-                func_str = self._generate_function_header(run_name, i) + self._generate_function_body(i)
+                is_async = any(a.get("coroutine", False) for a in self.script_dict[i])
+                func_str = self._generate_function_header(run_name, i, is_async) + self._generate_function_body(i)
                 exec_str_collection[i] = func_str
         if script_path:
             self._write_to_file(script_path, run_name, exec_str_collection)
@@ -477,7 +485,7 @@ class Script(db.Model):
             name += '_'
         return name
 
-    def _generate_function_header(self, run_name, stype):
+    def _generate_function_header(self, run_name, stype, is_async):
         """
         Generate the function header.
         """
@@ -487,7 +495,8 @@ class Script(db.Model):
                      config_type.items()]
 
         script_type = f"_{stype}" if stype != "script" else ""
-        function_header = f"def {run_name}{script_type}("
+        async_str = "async " if is_async else ""
+        function_header = f"{async_str}def {run_name}{script_type}("
 
         if stype == "script":
             function_header += ", ".join(configure)
@@ -540,7 +549,8 @@ class Script(db.Model):
         # elif instrument == 'registered_workflows':
         #     return inspect.getsource(my_function)
         else:
-            return self._process_instrument_action(indent_unit, instrument, action_name, args, save_data)
+            is_async = action.get("coroutine", False)
+            return self._process_instrument_action(indent_unit, instrument, action_name, args, save_data, is_async)
 
     def _process_args(self, args):
         """
@@ -600,10 +610,12 @@ class Script(db.Model):
             indent_unit -= 1
         return exec_string, indent_unit
 
-    def _process_instrument_action(self, indent_unit, instrument, action, args, save_data):
+    def _process_instrument_action(self, indent_unit, instrument, action, args, save_data, is_async=False):
         """
         Process actions related to instruments.
         """
+        async_str = "await " if is_async else ""
+
         function_call = f"{instrument}.{action}"
         if instrument.startswith("blocks"):
             self.blocks_included = True
@@ -611,11 +623,11 @@ class Script(db.Model):
 
         if isinstance(args, dict) and args != {}:
             args_str = self._process_dict_args(args)
-            single_line = f"{function_call}(**{args_str})"
+            single_line = f"{async_str}{function_call}(**{args_str})"
         elif isinstance(args, str):
             single_line = f"{function_call} = {args}"
         else:
-            single_line = f"{function_call}()"
+            single_line = f"{async_str}{function_call}()"
 
         if save_data:
             save_data += " = "

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/ivoryos/utils/global_config.py

@@ -17,6 +17,8 @@ class GlobalConfig:
             cls._instance._runner_lock = threading.Lock()
             cls._instance._runner_status = None
             cls._instance._optimizers = {}
+            cls._instance._notification_handlers = []
+
         return cls._instance
 
     @property
@@ -28,6 +30,15 @@ class GlobalConfig:
         if self._deck is None:
             self._deck = value
 
+    def register_notification(self, handler):
+        if not callable(handler):
+            raise ValueError("Handler must be callable")
+        self._notification_handlers.append(handler)
+
+    @property
+    def notification_handlers(self):
+        return self._notification_handlers
+
     @property
     def building_blocks(self):
         return self._building_blocks

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/ivoryos/utils/py_to_json.py

@@ -55,6 +55,10 @@ def convert_to_cards(source_code: str):
         )
 
     class CardVisitor(ast.NodeVisitor):
+        def __init__(self):
+            self.defined_types = {}  # <-- always exists
+
+
         def visit_FunctionDef(self, node):
             self.defined_types = {
                 arg.arg: ast.unparse(arg.annotation) if arg.annotation else "float"
@@ -142,14 +146,20 @@ def convert_to_cards(source_code: str):
                     "return": "",
                     "uuid": generate_uuid()
                 })
+            elif isinstance(node.value, ast.Await):
+                self.handle_call(node.value.value, ret_var=node.targets[0].id, awaited=True)
+
             elif isinstance(node.value, ast.Call):
                 self.handle_call(node.value, ret_var=node.targets[0].id)
 
         def visit_Expr(self, node):
-            if isinstance(node.value, ast.Call):
+            if isinstance(node.value, ast.Await):
+                # node.value is ast.Await
+                self.handle_call(node.value.value, awaited=True)
+            elif isinstance(node.value, ast.Call):
                 self.handle_call(node.value)
 
-        def handle_call(self, node, ret_var=""):
+        def handle_call(self, node, ret_var="", awaited=False):
             func_parts = []
             f = node.func
             while isinstance(f, ast.Attribute):
@@ -229,7 +239,7 @@ def convert_to_cards(source_code: str):
                         else infer_type(value)
                     )
 
-            add_card({
+            card = {
                 "action": action,
                 "arg_types": arg_types,
                 "args": args,
@@ -237,7 +247,12 @@ def convert_to_cards(source_code: str):
                 "instrument": instrument,
                 "return": ret_var,
                 "uuid": generate_uuid()
-            })
+            }
+
+            if awaited:
+                card["coroutine"] = True  # mark as coroutine if awaited
+
+            add_card(card)
 
     CardVisitor().visit(tree)
     return cards

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/ivoryos/utils/script_runner.py

@@ -1,4 +1,5 @@
 import ast
+import asyncio
 import os
 import csv
 import threading
@@ -19,6 +20,14 @@ class HumanInterventionRequired(Exception):
     pass
 
 def pause(reason="Human intervention required"):
+    handlers = global_config.notification_handlers
+    if handlers:
+        for handler in handlers:
+            try:
+                handler(reason)
+            except Exception as e:
+                print(f"[notify] handler {handler} failed: {e}")
+    # raise error to pause workflow in gui
     raise HumanInterventionRequired(reason)
 
 class ScriptRunner:
@@ -161,7 +170,7 @@ class ScriptRunner:
                 start_time=datetime.now(),
             )
             db.session.add(step)
-            db.session.commit()
+            db.session.flush()
 
             logger.info(f"Executing: {line}")
             socketio.emit('execution', {'section': f"{section_name}-{index}"})
@@ -174,7 +183,25 @@ class ScriptRunner:
                     duration = float(duration_str)
                     self.safe_sleep(duration)
                 else:
-                    exec(line, exec_globals, exec_locals)
+                    if "await " in line:
+                        async_code = f"async def __async_exec_wrapper():\n"
+                        # indent all code lines by 4 spaces
+                        async_code += "\n".join("    " + line for line in line.splitlines())
+                        async_code += f"\n    return locals()"
+                        exec(async_code, exec_globals, exec_locals)
+                        func = exec_locals.get("__async_exec_wrapper") or exec_globals.get("__async_exec_wrapper")
+                        # Capture the return value from asyncio.run
+                        result_locals = asyncio.run(func())
+
+                        # Update exec_locals with the returned locals
+                        exec_locals.update(result_locals)
+                        exec_locals.pop("__async_exec_wrapper", None)
+
+                    else:
+                        print("just exec synchronously")
+                        exec(line, exec_globals, exec_locals)
+                        # return locals_dict
+                    # exec(line, exec_globals, exec_locals)
                 # step.run_error = False
 
             except HumanInterventionRequired as e:
@@ -219,7 +246,7 @@ class ScriptRunner:
                               repeat_mode=repeat_mode
                               )
             db.session.add(run)
-            db.session.commit()
+            db.session.flush()
             run_id = run.id  # Save the ID
             try:
 
@@ -241,7 +268,7 @@ class ScriptRunner:
                 self._run_actions(script, section_name="cleanup", logger=logger, socketio=socketio,run_id=run_id)
                 # Reset the running flag when done
                 # Save results if necessary
-                if not script.python_script and output_list:
+                if not script.python_script and return_list:
                     filename = self._save_results(run_name, arg_type, return_list, output_list, logger, output_path)
                 self._emit_progress(socketio, 100)
 
@@ -277,7 +304,7 @@ class ScriptRunner:
             start_time=datetime.now()
         )
         db.session.add(phase)
-        db.session.commit()
+        db.session.flush()
         phase_id = phase.id
 
         step_outputs = self.exec_steps(script, section_name, logger, socketio, phase_id=phase_id)
@@ -317,7 +344,7 @@ class ScriptRunner:
                     start_time=datetime.now()
                 )
                 db.session.add(phase)
-                db.session.commit()
+                db.session.flush()
 
                 phase_id = phase.id
                 output = self.exec_steps(script, "script", logger, socketio, phase_id, **kwargs)
@@ -371,7 +398,7 @@ class ScriptRunner:
                 start_time=datetime.now()
             )
             db.session.add(phase)
-            db.session.commit()
+            db.session.flush()
             phase_id = phase.id
 
             logger.info(f'Executing {run_name} experiment: {i_progress + 1}/{int(repeat_count)}')

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/ivoryos/utils/task_runner.py

@@ -1,3 +1,5 @@
+import inspect
+import asyncio
 import threading
 import time
 from datetime import datetime
@@ -19,8 +21,7 @@ class TaskRunner:
         self.globals_dict = globals_dict
         self.lock = global_config.runner_lock
 
-
-    def run_single_step(self, component, method, kwargs, wait=True, current_app=None):
+    async def run_single_step(self, component, method, kwargs, wait=True, current_app=None):
         global deck
         if deck is None:
             deck = global_config.deck
@@ -29,18 +30,18 @@ class TaskRunner:
         if not self.lock.acquire(blocking=False):
             current_status = global_config.runner_status
             current_status["status"] = "busy"
+            current_status["output"] = "busy"
             return current_status
 
-
         if wait:
-            output = self._run_single_step(component, method, kwargs, current_app)
+            output = await self._run_single_step(component, method, kwargs, current_app)
         else:
-            print("running with thread")
-            thread = threading.Thread(
-                target=self._run_single_step, args=(component, method, kwargs, current_app)
-            )
-            thread.start()
-            time.sleep(0.1)
+            # Create background task properly
+            async def background_runner():
+                await self._run_single_step(component, method, kwargs, current_app)
+
+            asyncio.create_task(background_runner())
+            await asyncio.sleep(0.1)  # Change time.sleep to await asyncio.sleep
             output = {"status": "task started", "task_id": global_config.runner_status.get("id")}
 
         return output
@@ -59,22 +60,32 @@ class TaskRunner:
             function_executable = getattr(instrument, method)
         return function_executable
 
-    def _run_single_step(self, component, method, kwargs, current_app=None):
+    async def _run_single_step(self, component, method, kwargs, current_app=None):
         try:
             function_executable = self._get_executable(component, deck, method)
             method_name = f"{component}.{method}"
         except Exception as e:
             self.lock.release()
-            return {"status": "error", "msg": e.__str__()}
+            return {"status": "error", "msg": str(e)}
 
-        # with self.lock:
+        # Flask context is NOT async → just use normal "with"
         with current_app.app_context():
-            step = SingleStep(method_name=method_name, kwargs=kwargs, run_error=None, start_time=datetime.now())
+            step = SingleStep(
+                method_name=method_name,
+                kwargs=kwargs,
+                run_error=None,
+                start_time=datetime.now()
+            )
             db.session.add(step)
-            db.session.commit()
-            global_config.runner_status = {"id":step.id, "type": "task"}
+            db.session.flush()
+            global_config.runner_status = {"id": step.id, "type": "task"}
+
             try:
-                output = function_executable(**kwargs)
+                if inspect.iscoroutinefunction(function_executable):
+                    output = await function_executable(**kwargs)
+                else:
+                    output = function_executable(**kwargs)
+
                 step.output = output
                 step.end_time = datetime.now()
                 success = True
@@ -86,4 +97,5 @@ class TaskRunner:
             finally:
                 db.session.commit()
                 self.lock.release()
-            return dict(success=success, output=output)
+
+            return dict(success=success, output=output)

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/ivoryos/utils/utils.py

@@ -105,7 +105,8 @@ def _inspect_class(class_object=None, debug=False):
             try:
                 annotation = inspect.signature(method)
                 docstring = inspect.getdoc(method)
-                functions[function] = dict(signature=annotation, docstring=docstring)
+                coroutine = inspect.iscoroutinefunction(method)
+                functions[function] = dict(signature=annotation, docstring=docstring, coroutine=coroutine,)
 
             except Exception:
                 pass
@@ -141,6 +142,7 @@ def _get_type_from_parameters(arg, parameters):
 def _convert_by_str(args, arg_types):
     """
     Converts a value to type through eval(f'{type}("{args}")')
+    v1.3.4 TODO try str lastly, otherwise it's always converted to str
     """
     if type(arg_types) is not list:
         arg_types = [arg_types]

ivoryos-1.3.5a0/ivoryos/version.py

@@ -0,0 +1 @@
+__version__ = "1.3.5a0"

{ivoryos-1.3.3 → ivoryos-1.3.5a0}/ivoryos.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ivoryos
-Version: 1.3.3
+Version: 1.3.5a0
 Summary: an open-source Python package enabling Self-Driving Labs (SDLs) interoperability
 Author-email: Ivory Zhang <ivoryzhang@chem.ubc.ca>
 License: MIT
@@ -28,7 +28,8 @@ Dynamic: license-file
 [![YouTube](https://img.shields.io/badge/YouTube-tutorial-red?logo=youtube)](https://youtu.be/dFfJv9I2-1g)
 [![YouTube](https://img.shields.io/badge/YouTube-demo-red?logo=youtube)](https://youtu.be/flr5ydiE96s)
 [![Published](https://img.shields.io/badge/Nature_Comm.-paper-blue)](https://www.nature.com/articles/s41467-025-60514-w)
-[![Discord](https://img.shields.io/discord/1313641159356059770?label=Discord&logo=discord&color=5865F2)](https://discord.gg/AX5P9EdGVX)
+
+[//]: # ([![Discord]&#40;https://img.shields.io/discord/1313641159356059770?label=Discord&logo=discord&color=5865F2&#41;]&#40;https://discord.gg/AX5P9EdGVX&#41;)
 
 ![](https://gitlab.com/heingroup/ivoryos/raw/main/docs/source/_static/ivoryos.png)
 # ivoryOS: interoperable Web UI for self-driving laboratories (SDLs)
@@ -101,11 +102,14 @@ pip install -e .
 ## Quick start
 In your SDL script, 
 ```python
+my_robot = Robot()
+
 import ivoryos
 
 ivoryos.run(__name__)
 ```
-Login: Create an account (local DB, bcrypt password)
+You can now access the web UI at http://127.0.0.1:8000,
+create an account, login, and start designing workflows!
 
 ----
 ## Features
@@ -127,6 +131,28 @@ Add single or multiple loggers:
 ivoryos.run(__name__, logger="logger name")
 ivoryos.run(__name__, logger=["logger 1", "logger 2"])
 ```
+### Human-in-the-loop
+Add single or multiple notification handlers for `pause` feature in flow control:
+```python
+
+def slack_bot(msg: str = "Hi"):
+    """
+    a function that can be used as a notification handler function("msg")
+    :param msg: message to send
+    """
+    from slack_sdk import WebClient
+
+    slack_token = "your slack token"
+    client = WebClient(token=slack_token)
+
+    my_user_id = "your user id"  # replace with your actual Slack user ID
+
+    client.chat_postMessage(channel=my_user_id, text=msg)
+
+import ivoryos
+ivoryos.run(__name__, notification_handler=slack_bot)
+```
+
 ### Directory Structure
 
 Created automatically on first run:
@@ -152,11 +178,10 @@ ivoryos.run(__name__)
 
 ## Roadmap
 
-- [x] Allow plugin pages ✅  
-- [x] pause, resume, abort current and pending workflows ✅
 - [ ] dropdown input 
 - [ ] snapshot version control
 - [ ] optimizer-agnostic
+- [ ] prefect compatibility
 - [ ] check batch-config file compatibility
 
 ---
@@ -198,4 +223,4 @@ For an additional perspective related to the development of the tool, please see
 ```
 ---
 ## Acknowledgements
-Authors acknowledge Telescope Innovations Corp., Hein Lab members for their valuable suggestions and contributions.
+Authors acknowledge Telescope Innovations Corp., UBC Hein Lab, and Acceleration Consortium members for their valuable suggestions and contributions.

ivoryos-1.3.3/ivoryos/version.py

@@ -1 +0,0 @@
-__version__ = "1.3.3"