ivoryos 0.1.12__py3-none-any.whl → 0.1.18__py3-none-any.whl

ivoryos/__init__.py

@@ -1,8 +1,10 @@
+import importlib
+import inspect
 import os
 import sys
 from typing import Union
 
-from flask import Flask, redirect, url_for
+from flask import Flask, redirect, url_for, Blueprint, g
 
 from ivoryos.config import Config, get_config
 from ivoryos.routes.auth.auth import auth, login_manager
@@ -10,22 +12,18 @@ from ivoryos.routes.control.control import control
 from ivoryos.routes.database.database import database
 from ivoryos.routes.design.design import design, socketio
 from ivoryos.routes.main.main import main
+# from ivoryos.routes.monitor.monitor import monitor
 from ivoryos.utils import utils
 from ivoryos.utils.db_models import db
 from ivoryos.utils.global_config import GlobalConfig
 from ivoryos.utils.script_runner import ScriptRunner
 from ivoryos.version import __version__ as ivoryos_version
-
+from importlib.metadata import entry_points
 global_config = GlobalConfig()
 
-
 url_prefix = os.getenv('URL_PREFIX', "/ivoryos")
 app = Flask(__name__, static_url_path=f'{url_prefix}/static', static_folder='static')
-app.register_blueprint(main, url_prefix=url_prefix)
-app.register_blueprint(auth, url_prefix=url_prefix)
-app.register_blueprint(design, url_prefix=url_prefix)
-app.register_blueprint(database, url_prefix=url_prefix)
-app.register_blueprint(control, url_prefix=url_prefix)
+
 
 def create_app(config_class=None):
     # url_prefix = os.getenv('URL_PREFIX', "/ivoryos")
@@ -55,12 +53,9 @@ def create_app(config_class=None):
         Called before
 
         """
-        from flask import g
         g.logger = logger
         g.socketio = socketio
 
-
-
     @app.route('/')
     def redirect_to_prefix():
         return redirect(url_for('main.index', version=ivoryos_version))  # Assuming 'index' is a route in your blueprint
@@ -72,6 +67,7 @@ def run(module=None, host="0.0.0.0", port=None, debug=None, llm_server=None, mod
         config: Config = None,
         logger: Union[str, list] = None,
         logger_output_name: str = None,
+        enable_design=True
         ):
     """
     Start ivoryOS app server.
@@ -85,22 +81,43 @@ def run(module=None, host="0.0.0.0", port=None, debug=None, llm_server=None, mod
     :param config: config class, defaults to None
     :param logger: logger name of list of logger names, defaults to None
     :param logger_output_name: log file save name of logger, defaults to None, and will use "default.log"
-
+    :param enable_design: enable design canvas, database and workflow execution
+    :param stream_address:
     """
     app = create_app(config_class=config or get_config())  # Create app instance using factory function
 
+    app.register_blueprint(main, url_prefix=url_prefix)
+    app.register_blueprint(auth, url_prefix=url_prefix)
+    app.register_blueprint(control, url_prefix=url_prefix)
+
+    if enable_design:
+        app.register_blueprint(design, url_prefix=url_prefix)
+        app.register_blueprint(database, url_prefix=url_prefix)
+
+    plugins = load_plugins(app, socketio)
+
+    def inject_nav_config():
+        """Make NAV_CONFIG available globally to all templates."""
+        return dict(
+            enable_design=enable_design,
+            plugins=plugins,
+        )
+
+    app.context_processor(inject_nav_config)
     port = port or int(os.environ.get("PORT", 8000))
     debug = debug if debug is not None else app.config.get('DEBUG', True)
 
     app.config["LOGGERS"] = logger
-    app.config["LOGGERS_PATH"] = logger_output_name or app.config["LOGGERS_PATH"] # default.log
+    app.config["LOGGERS_PATH"] = logger_output_name or app.config["LOGGERS_PATH"]  # default.log
     logger_path = os.path.join(app.config["OUTPUT_FOLDER"], app.config["LOGGERS_PATH"])
 
     if module:
         app.config["MODULE"] = module
         app.config["OFF_LINE"] = False
         global_config.deck = sys.modules[module]
-        global_config.deck_snapshot = utils.create_deck_snapshot(global_config.deck, output_path=app.config["DUMMY_DECK"], save=True)
+        # global_config.heinsight = HeinsightAPI("http://127.0.0.1:8080")
+        global_config.deck_snapshot = utils.create_deck_snapshot(global_config.deck,
+                                                                 output_path=app.config["DUMMY_DECK"], save=True)
         # global_config.runner = ScriptRunner(globals())
     else:
         app.config["OFF_LINE"] = True
@@ -120,3 +137,22 @@ def run(module=None, host="0.0.0.0", port=None, debug=None, llm_server=None, mod
         for log in logger:
             utils.start_logger(socketio, log_filename=logger_path, logger_name=log)
     socketio.run(app, host=host, port=port, debug=debug, use_reloader=False, allow_unsafe_werkzeug=True)
+    # return app
+
+
+def load_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

ivoryos/routes/control/templates/control/controllers.html

@@ -16,6 +16,7 @@
             {% if function not in hidden_instrument %}
                 <div class="card" id="{{function}}">
                     <div class="bg-white rounded shadow-sm flex-fill">
+                        <i class="bi bi-info-circle ms-2" data-bs-toggle="tooltip" data-bs-placement="top" title='{{ form.hidden_name.description or "Docstring is not available" }}' ></i>
                         <a style="float: right" aria-label="Close" href="{{ url_for('control.hide_function', instrument=instrument, function=function) }}"><i class="bi bi-eye-slash-fill"></i></a>
                         <div class="form-control" style="border: none">
                             <form role="form" method='POST' name="{{function}}" id="{{function}}">
@@ -38,7 +39,9 @@
                                 </div>
                                 <div class="input-group mb-3">
                                     <button type="submit" name="{{ function }}" id="{{ function }}" class="form-control" style="background-color: #a5cece;">{{format_name(function)}} </button>
+
                                 </div>
+
                             </form>
                         </div>
                     </div>

ivoryos/routes/design/design.py

@@ -12,7 +12,8 @@ from werkzeug.utils import secure_filename
 
 from ivoryos.utils import utils
 from ivoryos.utils.global_config import GlobalConfig
-from ivoryos.utils.form import create_builtin_form, create_action_button, format_name, create_form_from_pseudo
+from ivoryos.utils.form import create_builtin_form, create_action_button, format_name, create_form_from_pseudo, \
+    create_form_from_action
 from ivoryos.utils.db_models import Script
 from ivoryos.utils.script_runner import ScriptRunner
 
@@ -99,25 +100,29 @@ def experiment_builder(instrument=None):
 
     deck_list = utils.available_pseudo_deck(current_app.config["DUMMY_DECK"])
 
-    functions = []
+    functions = {}
     if deck:
         deck_variables = global_config.deck_snapshot.keys()
     else:
         deck_variables = list(pseudo_deck.keys()) if pseudo_deck else []
         deck_variables.remove("deck_name") if len(deck_variables) > 0 else deck_variables
-    if instrument:
+    edit_action_info = session.get("edit_action")
+    if edit_action_info:
+        forms = create_form_from_action(edit_action_info, script=script)
+    elif instrument:
         if instrument in ['if', 'while', 'variable', 'wait', 'repeat']:
-            forms = create_builtin_form(instrument, autofill=autofill, script=script)
+            forms = create_builtin_form(instrument, script=script)
         else:
             if deck:
-                function_metadata = global_config.deck_snapshot.get(instrument, {})
+                functions = global_config.deck_snapshot.get(instrument, {})
             elif pseudo_deck:
-                function_metadata = pseudo_deck.get(instrument, {})
-            functions = {key: data.get('signature', {}) for key, data in function_metadata.items()}
+                functions = pseudo_deck.get(instrument, {})
+            # print(function_metadata)
+            # functions = {key: data.get('signature', {}) for key, data in function_metadata.items()}
             forms = create_form_from_pseudo(pseudo=functions, autofill=autofill, script=script)
         if request.method == 'POST' and "hidden_name" in request.form:
-            all_kwargs = request.form.copy()
-            method_name = all_kwargs.pop("hidden_name", None)
+            # all_kwargs = request.form.copy()
+            method_name = request.form.get("hidden_name", None)
             # if method_name is not None:
             form = forms.get(method_name)
             kwargs = {field.name: field.data for field in form if field.name != 'csrf_token'}
@@ -125,29 +130,15 @@ def experiment_builder(instrument=None):
             if form and form.validate_on_submit():
                 function_name = kwargs.pop("hidden_name")
                 save_data = kwargs.pop('return', '')
-                variable_kwargs = {}
-                variable_kwargs_types = {}
 
-                try:
-                    variable_kwargs, variable_kwargs_types = utils.find_variable_in_script(script, kwargs)
-
-                    for name in variable_kwargs.keys():
-                        del kwargs[name]
-                    primitive_arg_types = utils.get_arg_type(kwargs, functions[function_name])
-
-                except:
-                    primitive_arg_types = utils.get_arg_type(kwargs, functions[function_name])
-
-                kwargs.update(variable_kwargs)
-                arg_types = {}
-                arg_types.update(variable_kwargs_types)
-                arg_types.update(primitive_arg_types)
-                all_kwargs.update(variable_kwargs)
+                primitive_arg_types = utils.get_arg_type(kwargs, functions[function_name])
 
+                script.eval_list(kwargs, primitive_arg_types)
+                kwargs = script.validate_variables(kwargs)
                 action = {"instrument": instrument, "action": function_name,
-                          "args": {name: arg for (name, arg) in kwargs.items()},
+                          "args": kwargs,
                           "return": save_data,
-                          'arg_types': arg_types}
+                          'arg_types': primitive_arg_types}
                 script.add_action(action=action)
             else:
                 flash(form.errors)
@@ -155,9 +146,13 @@ def experiment_builder(instrument=None):
         elif request.method == 'POST' and "builtin_name" in request.form:
             kwargs = {field.name: field.data for field in forms if field.name != 'csrf_token'}
             if forms.validate_on_submit():
+                # print(kwargs)
                 logic_type = kwargs.pop('builtin_name')
                 if 'variable' in kwargs:
-                    script.add_variable(**kwargs)
+                    try:
+                        script.add_variable(**kwargs)
+                    except ValueError:
+                        flash("Invalid variable type")
                 else:
                     script.add_logic_action(logic_type=logic_type, **kwargs)
             else:
@@ -168,12 +163,13 @@ def experiment_builder(instrument=None):
             autofill = not autofill
             forms = create_form_from_pseudo(functions, autofill=autofill, script=script)
             session['autofill'] = autofill
+
     utils.post_script_file(script)
-    design_buttons = [create_action_button(i) for i in script.currently_editing_script]
+    design_buttons = create_action_button(script)
     return render_template('experiment_builder.html', off_line=off_line, instrument=instrument, history=deck_list,
                            script=script, defined_variables=deck_variables,
                            local_variables=global_config.defined_variables,
-                           functions=functions, forms=forms, buttons=design_buttons, format_name=format_name,
+                           forms=forms, buttons=design_buttons, format_name=format_name,
                            use_llm=enable_llm)
 
 
@@ -250,10 +246,14 @@ def experiment_run():
     #     module = current_app.config.get('MODULE', '')
     #     deck = sys.modules[module] if module else None
     #     script.deck = os.path.splitext(os.path.basename(deck.__file__))[0]
-    design_buttons = {stype: [create_action_button(i) for i in script.get_script(stype)] for stype in script.stypes}
+    design_buttons = {stype: create_action_button(script, stype) for stype in script.stypes}
     config_preview = []
     config_file_list = [i for i in os.listdir(current_app.config["CSV_FOLDER"]) if not i == ".gitkeep"]
-    exec_string = script.compile(current_app.config['SCRIPT_FOLDER'])
+    try:
+        exec_string = script.compile(current_app.config['SCRIPT_FOLDER'])
+    except ValueError as e:
+        flash(e.__str__())
+        return redirect(url_for("design.experiment_builder"))
     # print(exec_string)
     config_file = request.args.get("filename")
     config = []
@@ -492,14 +492,20 @@ def edit_action(uuid: str):
     script = utils.get_script_file()
     action = script.find_by_uuid(uuid)
     session['edit_action'] = action
-    if request.method == "POST":
+
+    if request.method == "POST" and action is not None:
+        forms = create_form_from_action(action, script=script)
         if "back" not in request.form:
-            args = request.form.to_dict()
-            save_as = args.pop('return', '')
-            try:
-                script.update_by_uuid(uuid=uuid, args=args, output=save_as)
-            except Exception as e:
-                flash(e.__str__())
+            kwargs = {field.name: field.data for field in forms if field.name != 'csrf_token'}
+            # print(kwargs)
+            if forms and forms.validate_on_submit():
+                save_as = kwargs.pop('return', '')
+                kwargs = script.validate_variables(kwargs)
+            # try:
+                script.update_by_uuid(uuid=uuid, args=kwargs, output=save_as)
+            # except Exception as e:
+            else:
+                flash(forms.errors)
         session.pop('edit_action')
     return redirect(url_for('design.experiment_builder'))
 

ivoryos/routes/design/templates/design/experiment_builder.html

@@ -30,6 +30,7 @@
 
             {# edit action #}
             {% if session["edit_action"] %}
+{#                {{ session["edit_action"] }}#}
                 {% with action = session["edit_action"] %}
                     <h5> {{ format_name(action['action']) }} </h5>
                     <form role="form" method='POST' name="{{instrument}}" action="{{ url_for('design.edit_action', uuid=session["edit_action"]['uuid']) }}">
@@ -41,16 +42,26 @@
                                     <input class="form-control" type="text" id="arg" name="arg" placeholder="{{ action['arg_types']}}" value="{{ action['args'] }}" aria-labelledby="variableHelpBlock">
                                 </div>
                             {% else %}
-                                {% for arg in action['args'] %}
-                                <div class="input-group mb-3">
-                                    <label class="input-group-text">{{ format_name(arg) }}</label>
-                                    <input class="form-control" type="text" id="{{ arg }}" name="{{ arg }}" placeholder="{{ action['arg_types'][arg] }}" value="{{ action['args'][arg] }}" aria-labelledby="variableHelpBlock">
-                                </div>
+{#                                {% for arg in action['args'] %}#}
+{#                                <div class="input-group mb-3">#}
+{#                                    <label class="input-group-text">{{ format_name(arg) }}</label>#}
+{#                                    <input class="form-control" type="text" id="{{ arg }}" name="{{ arg }}" placeholder="{{ action['arg_types'][arg] }}" value="{{ action['args'][arg] }}" aria-labelledby="variableHelpBlock">#}
+{#                                </div>#}
+{#                                {% endfor %}#}
+{#                                <div class="input-group mb-3">#}
+{#                                    <label class="input-group-text">Save Output?</label>#}
+{#                                    <input class="form-control" type="text" id="return" name="return"  value="{{ action['return'] }}" aria-labelledby="variableHelpBlock">#}
+{#                                </div>#}
+                                {{ forms.hidden_tag() }}
+                                {% for field in forms %}
+                                    {% if field.type not in ['CSRFTokenField'] %}
+                                        <div class="input-group mb-3">
+                                            <label class="input-group-text">{{ field.label.text }}</label>
+                                            {{ field(class="form-control") }}
+                                            <div class="form-text">{{ field.description }} </div>
+                                        </div>
+                                    {% endif %}
                                 {% endfor %}
-                                <div class="input-group mb-3">
-                                    <label class="input-group-text">Save Output?</label>
-                                    <input class="form-control" type="text" id="return" name="return"  value="{{ action['return'] }}" aria-labelledby="variableHelpBlock">
-                                </div>
                             {% endif %}
                         </div>
                         {% endif %}
@@ -139,12 +150,12 @@
                                             {{ format_name(name) }}
                                         </button>
                                     </h2>
+
                                     <div id="{{name}}" class="accordion-collapse collapse" data-bs-parent="#accordionActions">
                                         <div class="accordion-body">
                                             <form role="form" method='POST' name="add" id="add">
                                                 <div class="form-group">
                                                     {{ form.hidden_tag() }}
-{#                                                    {{ form.hidden_name() }}#}
                                                     {% for field in form %}
                                                         {% if field.type not in ['CSRFTokenField', 'HiddenField'] %}
                                                             <div class="input-group mb-3">
@@ -161,6 +172,8 @@
                                                     {% endfor %}
                                                 </div>
                                                 <button type="submit" class="btn btn-dark">Add </button>
+                                                <i class="bi bi-info-circle ms-2" data-bs-toggle="tooltip" data-bs-placement="top" title='{{ form.hidden_name.description or "Docstring is not available" }}' ></i>
+
                                             </form>
 
 

ivoryos/routes/main/templates/main/home.html

@@ -9,32 +9,32 @@
         </h1>
         <p>Version: {{ version }}</p>
         <div class="row">
-
-            <div class="col-lg-6 mb-4 d-flex align-items-stretch">
-                <div class="card rounded shadow-sm flex-fill">
-                    <div class="card-body">
-                        <h5 class="card-title">Browse designs</h5>
-                        <p class="card-text">Browse all workflows saved in the database.</p>
-                        <a href="{{ url_for('database.load_from_database') }}" class="stretched-link"></a>
+            {% if enable_design %}
+                <div class="col-lg-6 mb-4 d-flex align-items-stretch">
+                    <div class="card rounded shadow-sm flex-fill">
+                        <div class="card-body">
+                            <h5 class="card-title">Browse designs</h5>
+                            <p class="card-text">Browse all workflows saved in the database.</p>
+                            <a href="{{ url_for('database.load_from_database') }}" class="stretched-link"></a>
+                        </div>
                     </div>
                 </div>
-            </div>
-            <div class="col-lg-6 mb-4 d-flex align-items-stretch">
-                <div class="card rounded shadow-sm flex-fill">
-                    <div class="card-body">
-                        <h5 class="card-title">Edit designs</h5>
-                        <p class="card-text">Build your workflow from current deck functions.</p>
-                        <a href="{{ url_for('design.experiment_builder') }}" class="stretched-link"></a>
+                <div class="col-lg-6 mb-4 d-flex align-items-stretch">
+                    <div class="card rounded shadow-sm flex-fill">
+                        <div class="card-body">
+                            <h5 class="card-title">Edit designs</h5>
+                            <p class="card-text">Build your workflow from current deck functions.</p>
+                            <a href="{{ url_for('design.experiment_builder') }}" class="stretched-link"></a>
+                        </div>
                     </div>
                 </div>
-            </div>
+            {% endif %}
         </div>
 
         <br><br><br>
         {% if not off_line %}
-{#            <h5>Only available in online mode</h5>#}
-{#            <hr>#}
             <div class="row">
+                {% if enable_design %}
                 <div class="col-lg-6 mb-4 d-flex align-items-stretch">
                     <div class="card rounded shadow-sm flex-fill">
                         <div class="card-body">
@@ -44,6 +44,8 @@
                         </div>
                     </div>
                 </div>
+                {% endif %}
+
                 <div class="col-lg-6 mb-4 d-flex align-items-stretch">
                     <div class="card rounded shadow-sm flex-fill">
                         <div class="card-body">

ivoryos/templates/base.html

@@ -23,7 +23,7 @@
 <body>
     <nav class="navbar navbar-expand-lg navbar-light bg-light fixed-top">
         <div class= "container">
-
+{#            {{ module_config }}#}
             <a class="navbar-brand" href="{{ url_for('main.index') }}">
                 <img src="{{url_for('static', filename='logo.webp')}}" alt="Logo" height="60" class="d-inline-block align-text-bottom">
             </a>
@@ -36,15 +36,18 @@
                     <li class="nav-item">
                         <a class="nav-link" href="{{ url_for('main.index') }}" aria-current="page">Home</a>
                     </li>
-                    <li class="nav-item">
-                        <a class="nav-link" href="{{ url_for('database.load_from_database') }}" aria-current="page">Library</a>
-                    </li>
-                    <li class="nav-item">
-                        <a class="nav-link" href="{{ url_for('design.experiment_builder') }}">Design</a>
-                    </li>
-                    <li class="nav-item">
-                        <a class="nav-link" href="{{ url_for('design.experiment_run') }}">Compile/Run</a>
-                    </li>
+                    {% if enable_design %}
+                        <li class="nav-item">
+                            <a class="nav-link" href="{{ url_for('database.load_from_database') }}" aria-current="page">Library</a>
+                        </li>
+                        <li class="nav-item">
+                            <a class="nav-link" href="{{ url_for('design.experiment_builder') }}">Design</a>
+                        </li>
+                        <li class="nav-item">
+                            <a class="nav-link" href="{{ url_for('design.experiment_run') }}">Compile/Run</a>
+                        </li>
+                    {% endif %}
+
                     <li class="nav-item">
                         <a class="nav-link" href="{{ url_for('control.deck_controllers') }}">Devices</a></li>
                     </li>
@@ -54,6 +57,13 @@
                     <li class="nav-item">
                         <a class="nav-link" href="{{ url_for('main.help_info') }}">About</a>
                     </li>
+                    {% if plugins %}
+                        {% for plugin in plugins %}
+                            <li class="nav-item">
+                                <a class="nav-link" href="{{ url_for(plugin+'.main') }}">{{ plugin.capitalize() }}</a></li>
+                            </li>
+                        {% endfor %}
+                    {% endif %}
                 </ul>
                 <ul class="navbar-nav ms-auto">