ivoryos 1.0.1__tar.gz → 1.0.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ivoryos
-Version: 1.0.1
+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

{ivoryos-1.0.1 → 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.1 → ivoryos-1.0.3}/ivoryos/routes/control/control.py

@@ -1,8 +1,10 @@
 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
@@ -14,7 +16,7 @@ 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():
     """
@@ -22,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):
     """
@@ -38,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
@@ -88,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():
     """
@@ -96,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):
     """
@@ -111,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
@@ -154,24 +157,50 @@ 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
+
+    download proxy interface
 
-@control.route("/backend_control/<instrument>", methods=['POST'])
+    .. 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':
         method_name = request.form.get("hidden_name", None)
@@ -183,42 +212,48 @@ def backend_control(instrument: str=None):
                                             current_app=current_app._get_current_object())
             return jsonify(output), 200
 
-
-@control.route("/backend_control", methods=['GET'])
-def backend_client():
-    """
-    .. :quickref: Backend Control; get snapshot
-
-    backend control through http requests
-
-    .. 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')
@@ -266,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
 
@@ -304,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>
 
@@ -320,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>
 
@@ -341,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.1 → 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>

{ivoryos-1.0.1 → ivoryos-1.0.3}/ivoryos/routes/database/database.py

@@ -8,21 +8,21 @@ database = Blueprint('database', __name__, template_folder='templates/database')
 
 
 
-@database.route("/edit_workflow/<workflow_name>")
+@database.route("/database/scripts/edit/<script_name>")
 @login_required
-def edit_workflow(workflow_name):
+def edit_workflow(script_name:str):
     """
-    .. :quickref: Database; load workflow to canvas
+    .. :quickref: Database; load workflow script to canvas
 
     load the selected workflow to the design canvas
 
-    .. http:get:: /edit_workflow/<workflow_name>
+    .. http:get:: /database/scripts/edit/<script_name>
 
-    :param workflow_name: workflow name
-    :type workflow_name: str
+    :param script_name: script name
+    :type script_name: str
     :status 302: redirect to :http:get:`/ivoryos/experiment/build/`
     """
-    row = Script.query.get(workflow_name)
+    row = Script.query.get(script_name)
     script = Script(**row.as_dict())
     post_script_file(script)
     pseudo_name = session.get("pseudo_deck", "")
@@ -37,27 +37,27 @@ def edit_workflow(workflow_name):
     return redirect(url_for('design.experiment_builder'))
 
 
-@database.route("/delete_workflow/<workflow_name>")
+@database.route("/database/scripts/delete/<script_name>")
 @login_required
-def delete_workflow(workflow_name: str):
+def delete_workflow(script_name: str):
     """
     .. :quickref: Database; delete workflow
 
     delete workflow from database
 
-    .. http:get:: /delete_workflow/<workflow_name>
+    .. http:get:: /database/scripts/delete/<script_name>
 
-    :param workflow_name: workflow name
-    :type workflow_name: str
-    :status 302: redirect to :http:get:`/ivoryos/database/`
+    :param script_name: workflow name
+    :type script_name: str
+    :status 302: redirect to :http:get:`/ivoryos/database/scripts/`
 
     """
-    Script.query.filter(Script.name == workflow_name).delete()
+    Script.query.filter(Script.name == script_name).delete()
     db.session.commit()
     return redirect(url_for('database.load_from_database'))
 
 
-@database.route("/publish")
+@database.route("/database/scripts/save")
 @login_required
 def publish():
     """
@@ -65,7 +65,7 @@ def publish():
 
     save workflow to database
 
-    .. http:get:: /publish
+    .. http:get:: /database/scripts/save
 
     :status 302: redirect to :http:get:`/ivoryos/experiment/build/`
     """
@@ -84,7 +84,7 @@ def publish():
     return redirect(url_for('design.experiment_builder'))
 
 
-@database.route("/finalize")
+@database.route("/database/scripts/finalize")
 @login_required
 def finalize():
     """
@@ -106,8 +106,8 @@ def finalize():
     return redirect(url_for('design.experiment_builder'))
 
 
-@database.route("/database/", strict_slashes=False)
-@database.route("/database/<deck_name>")
+@database.route("/database/scripts/", strict_slashes=False)
+@database.route("/database/scripts/<deck_name>")
 @login_required
 def load_from_database(deck_name=None):
     """
@@ -115,7 +115,7 @@ def load_from_database(deck_name=None):
 
     backend control through http requests
 
-    .. http:get:: /database/<deck_name>
+    .. http:get:: /database/scripts/<deck_name>
 
     :param deck_name: filter for deck name
     :type deck_name: str
@@ -135,19 +135,19 @@ def load_from_database(deck_name=None):
     page = request.args.get('page', default=1, type=int)
     per_page = 10
 
-    workflows = query.paginate(page=page, per_page=per_page, error_out=False)
+    scripts = query.paginate(page=page, per_page=per_page, error_out=False)
     if request.accept_mimetypes.best_match(['application/json', 'text/html']) == 'application/json':
-        workflows = query.all()
-        workflow_names = [w.name for w in workflows]
+        scripts = query.all()
+        script_names = [script.name for script in scripts]
         return jsonify({
-            "workflows": workflow_names,
+            "workflows": script_names,
         })
     else:
         # return HTML
-        return render_template("experiment_database.html", workflows=workflows, deck_list=deck_list, deck_name=deck_name)
+        return render_template("scripts_database.html", scripts=scripts, deck_list=deck_list, deck_name=deck_name)
 
 
-@database.route("/edit_run_name", methods=['POST'])
+@database.route("/database/scripts/rename", methods=['POST'])
 @login_required
 def edit_run_name():
     """
@@ -155,7 +155,7 @@ def edit_run_name():
 
     edit the name of the current workflow, won't save to the database
 
-    .. http:post:: /edit_run_name
+    .. http:post:: database/scripts/rename
 
     : form run_name: new workflow name
     :status 302: redirect to :http:get:`/ivoryos/experiment/build/`
@@ -173,15 +173,15 @@ def edit_run_name():
         return redirect(url_for("design.experiment_builder"))
 
 
-@database.route("/save_as", methods=['POST'])
+@database.route("/database/scripts/save_as", methods=['POST'])
 @login_required
 def save_as():
     """
     .. :quickref: Database; save the run name as
 
-    save the workflow name as
+    save the current workflow script as
 
-    .. http:post:: /save_as
+    .. http:post:: /database/scripts/save_as
 
     : form run_name: new workflow name
     :status 302: redirect to :http:get:`/ivoryos/experiment/build/`
@@ -203,9 +203,20 @@ def save_as():
         return redirect(url_for("design.experiment_builder"))
 
 
-@database.route('/workflow_runs')
+# -----------------------------------------------------------
+# ------------------  Workflow logs   -----------------------
+# -----------------------------------------------------------
+@database.route('/database/workflows/')
 def list_workflows():
-    query = WorkflowRun.query
+    """
+    .. :quickref: Database; list all workflow logs
+
+    list all workflow logs
+
+    .. http:get:: /database/workflows/
+
+    """
+    query = WorkflowRun.query.order_by(WorkflowRun.id.desc())
     search_term = request.args.get("keyword", None)
     if search_term:
         query = query.filter(WorkflowRun.name.like(f'%{search_term}%'))
@@ -219,11 +230,20 @@ def list_workflows():
         return jsonify({
             "workflow_data": workflow_data,
         })
-    return render_template('workflow_run_database.html', workflows=workflows)
+    else:
+        return render_template('workflow_database.html', workflows=workflows)
 
 
-@database.route("/workflow_steps/<int:workflow_id>")
-def get_workflow_steps(workflow_id):
+@database.route("/database/workflows/<int:workflow_id>")
+def get_workflow_steps(workflow_id:int):
+    """
+    .. :quickref: Database; list all workflow logs
+
+    list all workflow logs
+
+    .. http:get:: /database/workflows/<int:workflow_id>
+
+    """
     workflow = WorkflowRun.query.get_or_404(workflow_id)
     steps = WorkflowStep.query.filter_by(workflow_id=workflow_id).order_by(WorkflowStep.start_time).all()
 
@@ -261,23 +281,23 @@ def get_workflow_steps(workflow_id):
             "workflow_info": workflow.as_dict(),
             "steps": grouped_json,
         })
-
-    return render_template("experiment_step_view.html", workflow=workflow, grouped=grouped)
+    else:
+        return render_template("workflow_view.html", workflow=workflow, grouped=grouped)
 
 
-@database.route("/delete_workflow_data/<workflow_id>")
+@database.route("/database/workflows/delete/<int:workflow_id>")
 @login_required
-def delete_workflow_data(workflow_id: str):
+def delete_workflow_data(workflow_id: int):
     """
     .. :quickref: Database; delete experiment data from database
 
     delete workflow data from database
 
-    .. http:get:: /delete_workflow_data/<workflow_id>
+    .. http:get:: /database/workflows/delete/<int:workflow_id>
 
     :param workflow_id: workflow id
-    :type workflow_id: str
-    :status 302: redirect to :http:get:`/ivoryos/workflow_runs/`
+    :type workflow_id: int
+    :status 302: redirect to :http:get:`/ivoryos/database/workflows/`
 
     """
     run = WorkflowRun.query.get(workflow_id)

ivoryos-1.0.1/ivoryos/routes/database/templates/database/experiment_database.html → ivoryos-1.0.3/ivoryos/routes/database/templates/database/scripts_database.html

@@ -35,19 +35,19 @@
             </tr>
         </thead>
         <tbody>
-            {% for workflow in workflows %}
+            {% for script in scripts %}
                 <tr>
-                    <td><a href="{{ url_for('database.edit_workflow', workflow_name=workflow.name) }}">{{ workflow.name }}</a></td>
-                    <td>{{ workflow.deck }}</td>
-                    <td>{{ workflow.status }}</td>
-                    <td>{{ workflow.time_created }}</td>
-                    <td>{{ workflow.last_modified }}</td>
-                    <td>{{ workflow.author }}</td>
+                    <td><a href="{{ url_for('database.edit_workflow', script_name=script.name) }}">{{ script.name }}</a></td>
+                    <td>{{ script.deck }}</td>
+                    <td>{{ script.status }}</td>
+                    <td>{{ script.time_created }}</td>
+                    <td>{{ script.last_modified }}</td>
+                    <td>{{ script.author }}</td>
 {#                    <td>{{ workflow.registered }}</td>#}
                     <td>
                         {#not workflow.status == "finalized" or#}
-                        {% if session['user'] == 'admin' or session['user'] == workflow.author %}
-                            <a href="{{ url_for('database.delete_workflow', workflow_name=workflow.name) }}">delete</a>
+                        {% if session['user'] == 'admin' or session['user'] == script.author %}
+                            <a href="{{ url_for('database.delete_workflow', script_name=script.name) }}">delete</a>
                         {% else %}
                             <a class="disabled-link">delete</a>
                         {% endif %}
@@ -57,18 +57,27 @@
         </tbody>
     </table>
 
-{#    paging#}
+    {#    paging#}
     <div class="pagination justify-content-center">
-        <div class="page-item {{ 'disabled' if not workflows.has_prev else '' }}">
-            <a class="page-link" href="{{ url_for('database.load_from_database', page=workflows.prev_num) }}">Previous</a>
+        <div class="page-item {{ 'disabled' if not scripts.has_prev else '' }}">
+            <a class="page-link" href="{{ url_for('database.load_from_database', page=scripts.prev_num) }}">Previous</a>
         </div>
-        {% for num in workflows.iter_pages() %}
-            <div class="page-item">
-                <a class="page-link {{ 'active' if num == workflows.page else '' }}" href="{{ url_for('database.load_from_database', page=num) }}">{{ num }}</a>
-            </div>
+
+        {% for num in scripts.iter_pages() %}
+            {% if num %}
+                <div class="page-item {{ 'active' if num == scripts.page else '' }}">
+                    <a class="page-link" href="{{ url_for('database.load_from_database', page=num) }}">{{ num }}</a>
+                </div>
+            {% else %}
+                <div class="page-item disabled">
+                    <span class="page-link">…</span>
+                </div>
+            {% endif %}
         {% endfor %}
-        <div class="page-item {{ 'disabled' if not workflows.has_next else '' }}">
-            <a class="page-link" href="{{ url_for('database.load_from_database', page=workflows.next_num) }}">Next</a>
+
+        <div class="page-item {{ 'disabled' if not scripts.has_next else '' }}">
+            <a class="page-link" href="{{ url_for('database.load_from_database', page=scripts.next_num) }}">Next</a>
         </div>
     </div>
+
 {% endblock %}