ivoryos 1.0.0__tar.gz → 1.0.3__tar.gz

{ivoryos-1.0.0/ivoryos.egg-info → ivoryos-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ivoryos
-Version: 1.0.0
+Version: 1.0.3
 Summary: an open-source Python package enabling Self-Driving Labs (SDLs) interoperability
 Home-page: https://gitlab.com/heingroup/ivoryos
 Author: Ivory Zhang
@@ -14,8 +14,8 @@ License-File: LICENSE
 [![PyPI version](https://img.shields.io/pypi/v/ivoryos)](https://pypi.org/project/ivoryos/)
 ![License](https://img.shields.io/pypi/l/ivoryos)
 [![YouTube](https://img.shields.io/badge/YouTube-video-red?logo=youtube)](https://youtu.be/dFfJv9I2-1g)
-[![Published](https://img.shields.io/badge/Nature_Communications-paper-blue)](https://www.nature.com/articles/s41467-025-60514-w)
-
+[![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)
 
 ![](https://gitlab.com/heingroup/ivoryos/raw/main/docs/source/_static/ivoryos.png)
 # ivoryOS: interoperable Web UI for self-driving laboratories (SDLs)

{ivoryos-1.0.0 → ivoryos-1.0.3}/README.md

@@ -2,8 +2,8 @@
 [![PyPI version](https://img.shields.io/pypi/v/ivoryos)](https://pypi.org/project/ivoryos/)
 ![License](https://img.shields.io/pypi/l/ivoryos)
 [![YouTube](https://img.shields.io/badge/YouTube-video-red?logo=youtube)](https://youtu.be/dFfJv9I2-1g)
-[![Published](https://img.shields.io/badge/Nature_Communications-paper-blue)](https://www.nature.com/articles/s41467-025-60514-w)
-
+[![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)
 
 ![](https://gitlab.com/heingroup/ivoryos/raw/main/docs/source/_static/ivoryos.png)
 # ivoryOS: interoperable Web UI for self-driving laboratories (SDLs)

{ivoryos-1.0.0 → ivoryos-1.0.3}/ivoryos/routes/auth/auth.py

@@ -9,7 +9,7 @@ login_manager = LoginManager()
 auth = Blueprint('auth', __name__, template_folder='templates/auth')
 
 
-@auth.route('/login', methods=['GET', 'POST'])
+@auth.route('/auth/login', methods=['GET', 'POST'])
 def login():
     """
     .. :quickref: User; login user
@@ -50,7 +50,7 @@ def login():
     return render_template('login.html')
 
 
-@auth.route('/signup', methods=['GET', 'POST'])
+@auth.route('/auth/signup', methods=['GET', 'POST'])
 def signup():
     """
     .. :quickref: User; signup for a new account
@@ -82,7 +82,7 @@ def signup():
     return render_template('signup.html')
 
 
-@auth.route("/logout")
+@auth.route("/auth/logout")
 @login_required
 def logout():
     """

{ivoryos-1.0.0 → ivoryos-1.0.3}/ivoryos/routes/control/control.py

@@ -1,18 +1,22 @@
 import os
 
-from flask import Blueprint, redirect, url_for, flash, request, render_template, session, current_app, jsonify
+from flask import Blueprint, redirect, url_for, flash, request, render_template, session, current_app, jsonify, \
+    send_file
 from flask_login import login_required
 
+from ivoryos.utils.client_proxy import export_to_python, create_function
 from ivoryos.utils.global_config import GlobalConfig
 from ivoryos.utils import utils
 from ivoryos.utils.form import create_form_from_module, format_name
+from ivoryos.utils.task_runner import TaskRunner
 
 global_config = GlobalConfig()
+runner = TaskRunner()
 
 control = Blueprint('control', __name__, template_folder='templates/control')
 
 
-@control.route("/my_deck")
+@control.route("/control/home/deck", strict_slashes=False)
 @login_required
 def deck_controllers():
     """
@@ -20,15 +24,15 @@ def deck_controllers():
 
     deck control home interface for listing all deck instruments
 
-    .. http:get:: /my_deck
+    .. http:get:: /control/home/deck
     """
     deck_variables = global_config.deck_snapshot.keys()
     deck_list = utils.import_history(os.path.join(current_app.config["OUTPUT_FOLDER"], 'deck_history.txt'))
     return render_template('controllers_home.html', defined_variables=deck_variables, deck=True, history=deck_list)
 
 
-@control.route("/new_controller/")
-@control.route("/new_controller/<instrument>", methods=['GET', 'POST'])
+@control.route("/control/new/", strict_slashes=False)
+@control.route("/control/new/<instrument>", methods=['GET', 'POST'])
 @login_required
 def new_controller(instrument=None):
     """
@@ -36,12 +40,12 @@ def new_controller(instrument=None):
 
     interface for connecting a new <instrument>
 
-    .. http:get:: /new_controller
+    .. http:get:: /control/new/
 
     :param instrument: instrument name
     :type instrument: str
 
-    .. http:post:: /new_controller
+    .. http:post:: /control/new/
 
     :form device_name: module instance name (e.g. my_instance = MyClass())
     :form kwargs: dynamic module initialization kwargs fields
@@ -86,7 +90,7 @@ def new_controller(instrument=None):
                            device=device, args=args, defined_variables=global_config.defined_variables)
 
 
-@control.route("/controllers")
+@control.route("/control/home/temp", strict_slashes=False)
 @login_required
 def controllers_home():
     """
@@ -94,14 +98,15 @@ def controllers_home():
 
     temporarily connected devices home interface for listing all instruments
 
-    .. http:get:: /controllers
+    .. http:get:: /control/home/temp
 
     """
     # defined_variables = parse_deck(deck)
-    return render_template('controllers_home.html', defined_variables=global_config.defined_variables)
+    defined_variables = global_config.defined_variables.keys()
+    return render_template('controllers_home.html', defined_variables=defined_variables)
 
 
-@control.route("/controllers/<instrument>", methods=['GET', 'POST'])
+@control.route("/control/<instrument>/methods", methods=['GET', 'POST'])
 @login_required
 def controllers(instrument: str):
     """
@@ -109,12 +114,12 @@ def controllers(instrument: str):
 
     control interface for selected <instrument>
 
-    .. http:get:: /controllers
+    .. http:get:: /control/<instrument>/methods
 
     :param instrument: instrument name
     :type instrument: str
 
-    .. http:post:: /controllers
+    .. http:post:: /control/<instrument>/methods
 
     :form hidden_name: function name (hidden field)
     :form kwargs: dynamic kwargs field
@@ -142,7 +147,9 @@ def controllers(instrument: str):
         if form and form.validate_on_submit():
             try:
                 kwargs.pop("hidden_name")
-                output = function_executable(**kwargs)
+                output = runner.run_single_step(instrument, method_name, kwargs, wait=True,
+                                                current_app=current_app._get_current_object())
+                # output = function_executable(**kwargs)
                 flash(f"\nRun Success! Output value: {output}.")
             except Exception as e:
                 flash(e.__str__())
@@ -150,81 +157,103 @@ def controllers(instrument: str):
             flash(form.errors)
     return render_template('controllers.html', instrument=instrument, forms=forms, format_name=format_name)
 
+@control.route("/control/download", strict_slashes=False)
+@login_required
+def download_proxy():
+    """
+    .. :quickref: Direct Control; download proxy interface
 
-@control.route("/backend_control/<instrument>", methods=['POST'])
+    download proxy interface
+
+    .. http:get:: /control/download
+    """
+    snapshot = global_config.deck_snapshot.copy()
+    class_definitions = {}
+    # Iterate through each instrument in the snapshot
+    for instrument_key, instrument_data in snapshot.items():
+        # Iterate through each function associated with the current instrument
+        for function_key, function_data in instrument_data.items():
+            # Convert the function signature to a string representation
+            function_data['signature'] = str(function_data['signature'])
+        class_name = instrument_key.split('.')[-1]  # Extracting the class name from the path
+        class_definitions[class_name.capitalize()] = create_function(request.url_root, class_name, instrument_data)
+    # Export the generated class definitions to a .py script
+    export_to_python(class_definitions, current_app.config["OUTPUT_FOLDER"])
+    filepath = os.path.join(current_app.config["OUTPUT_FOLDER"], "generated_proxy.py")
+    return send_file(os.path.abspath(filepath), as_attachment=True)
+
+@control.route("/api/control/", strict_slashes=False, methods=['GET'])
+@control.route("/api/control/<instrument>", methods=['POST'])
 def backend_control(instrument: str=None):
     """
     .. :quickref: Backend Control; backend control
 
     backend control through http requests
 
-    .. http:get:: /backend_control
+    .. http:get:: /api/control/
 
     :param instrument: instrument name
     :type instrument: str
 
-    .. http:post:: /backend_control
+    .. http:post:: /api/control/
 
     """
-    inst_object = find_instrument_by_name(instrument)
-    forms = create_form_from_module(sdl_module=inst_object, autofill=False, design=False)
+    if instrument:
+        inst_object = find_instrument_by_name(instrument)
+        forms = create_form_from_module(sdl_module=inst_object, autofill=False, design=False)
 
     if request.method == 'POST':
-        all_kwargs = request.form.copy()
-        method_name = all_kwargs.pop("hidden_name", None)
-        # if method_name is not None:
+        method_name = request.form.get("hidden_name", None)
         form = forms.get(method_name, None)
-        kwargs = {field.name: field.data for field in form if field.name != 'csrf_token'}
-        function_executable = getattr(inst_object, method_name)
         if form:
-            # print(kwargs)
-            try:
-                kwargs.pop("hidden_name")
-                output = function_executable(**kwargs)
-                json_output = jsonify(output)
-            except Exception as e:
-                json_output = jsonify(e.__str__())
-                return json_output, 400
-        else:
-            return "instrument not exist", 400
-        return json_output, 200
-
-
-@control.route("/backend_control", methods=['GET'])
-def backend_client():
-    """
-    .. :quickref: Backend Control; get snapshot
-
-    backend control through http requests
+            kwargs = {field.name: field.data for field in form if field.name not in ['csrf_token', 'hidden_name']}
+            wait = request.form.get("hidden_wait", "true") == "true"
+            output = runner.run_single_step(component=instrument, method=method_name, kwargs=kwargs, wait=wait,
+                                            current_app=current_app._get_current_object())
+            return jsonify(output), 200
 
-    .. http:get:: /backend_control
-    """
-    # Create a snapshot of the current deck configuration
     snapshot = global_config.deck_snapshot.copy()
-
     # Iterate through each instrument in the snapshot
     for instrument_key, instrument_data in snapshot.items():
         # Iterate through each function associated with the current instrument
         for function_key, function_data in instrument_data.items():
             # Convert the function signature to a string representation
             function_data['signature'] = str(function_data['signature'])
+    return jsonify(snapshot), 200
 
-    json_output = jsonify(snapshot)
-    return json_output, 200
+# @control.route("/api/control", strict_slashes=False, methods=['GET'])
+# def backend_client():
+#     """
+#     .. :quickref: Backend Control; get snapshot
+#
+#     backend control through http requests
+#
+#     .. http:get:: /api/control/summary
+#     """
+#     # Create a snapshot of the current deck configuration
+#     snapshot = global_config.deck_snapshot.copy()
+#
+#     # Iterate through each instrument in the snapshot
+#     for instrument_key, instrument_data in snapshot.items():
+#         # Iterate through each function associated with the current instrument
+#         for function_key, function_data in instrument_data.items():
+#             # Convert the function signature to a string representation
+#             function_data['signature'] = str(function_data['signature'])
+#     return jsonify(snapshot), 200
 
 
-@control.route("/import_api", methods=['POST'])
+@control.route("/control/import/module", methods=['POST'])
 def import_api():
     """
     .. :quickref: Advanced Features; Manually import API module(s)
 
     importing other Python modules
 
-    .. http:post:: /import_api
+    .. http:post:: /control/import/module
 
     :form filepath: API (Python class) module filepath
 
-    import the module and redirect to :http:get:`/ivoryos/new_controller/`
+    import the module and redirect to :http:get:`/ivoryos/control/new/`
 
     """
     filepath = request.form.get('filepath')
@@ -272,12 +301,12 @@ def import_api():
 #     return redirect(url_for('control.deck_controllers'))
 
 
-@control.route("/import_deck", methods=['POST'])
+@control.route("/control/import/deck", methods=['POST'])
 def import_deck():
     """
     .. :quickref: Advanced Features; Manually import a deck
 
-    .. http:post:: /import_deck
+    .. http:post:: /control/import_deck
 
     :form filepath: deck module filepath
 
@@ -310,12 +339,12 @@ def import_deck():
     return redirect(back)
 
 
-@control.route('/save-order/<instrument>', methods=['POST'])
+@control.route('/control/<instrument>/save-order', methods=['POST'])
 def save_order(instrument: str):
     """
     .. :quickref: Control Customization; Save functions' order
 
-    .. http:post:: /save-order
+    .. http:post:: /control/save-order
 
     save function drag and drop order for the given <instrument>
 
@@ -326,12 +355,12 @@ def save_order(instrument: str):
     return '', 204
 
 
-@control.route('/hide_function/<instrument>/<function>')
+@control.route('/control/<instrument>/<function>/hide')
 def hide_function(instrument, function):
     """
     .. :quickref: Control Customization; Hide function
 
-    .. http:get:: /hide_function
+    .. http:get:: //control/<instrument>/<function>/hide
 
     Hide the given <instrument> and <function>
 
@@ -347,12 +376,12 @@ def hide_function(instrument, function):
     return redirect(back)
 
 
-@control.route('/remove_hidden/<instrument>/<function>')
+@control.route('/control/<instrument>/<function>/unhide')
 def remove_hidden(instrument: str, function: str):
     """
     .. :quickref: Control Customization; Remove a hidden function
 
-    .. http:get:: /remove_hidden
+    .. http:get:: /control/<instrument>/<function>/unhide
 
     Un-hide the given <instrument> and <function>
 

{ivoryos-1.0.0 → ivoryos-1.0.3}/ivoryos/routes/control/templates/control/controllers_home.html

@@ -6,21 +6,21 @@
         {% for instrument in defined_variables %}
             <div class="col-xl-3 col-lg-4 col-md-6 mb-4 ">
                 <div class="bg-white rounded shadow-sm position-relative">
-{#                    {% if not deck %}#}
+                    {% if deck %}
 {#                        <a href="{{ url_for('control.disconnect', instrument=instrument) }}" class="stretched-link controller-card" style="float: right;color: red; position: relative;">Disconnect <i class="bi bi-x-square"></i></a>#}
                         <div class="p-4 controller-card">
                             <h5 class=""><a href="{{ url_for('control.controllers', instrument=instrument) }}" class="text-dark stretched-link">{{instrument.split(".")[1]}}</a></h5>
                         </div>
-{#                    {% else %}#}
-{#                        <div class="p-4 controller-card">#}
-{#                            <h5 class=""><a href="{{ url_for('control.controllers', instrument=instrument) }}" class="text-dark stretched-link">{{instrument}}</a></h5>#}
-{#                        </div>#}
-{#                    {% endif %}#}
+                    {% else %}
+                        <div class="p-4 controller-card">
+                            <h5 class=""><a href="{{ url_for('control.controllers', instrument=instrument) }}" class="text-dark stretched-link">{{instrument}}</a></h5>
+                        </div>
+                    {% endif %}
                 </div>
             </div>
         {% endfor %}
         <div class="d-flex mb-3">
-            <a href="{{ url_for('design.download', filetype='proxy') }}" class="btn btn-outline-primary">
+            <a href="{{ url_for('control.download_proxy', filetype='proxy') }}" class="btn btn-outline-primary">
                 <i class="bi bi-download"></i> Download remote control script
             </a>
         </div>