ivoryos 0.1.5__py3-none-any.whl

ivoryos/__init__.py

@@ -0,0 +1,94 @@
+import os
+import sys
+from typing import Union
+
+from flask import Flask
+
+from ivoryos.config import Config, get_config
+from ivoryos.routes.auth.auth import auth, login_manager
+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.utils import utils
+from ivoryos.utils.db_models import db
+from ivoryos.utils.global_config import GlobalConfig
+from ivoryos.utils.script_runner import ScriptRunner
+
+global_config = GlobalConfig()
+
+
+def create_app(config_class=None):
+    app = Flask(__name__)
+    app.config.from_object(config_class or 'config.get_config()')
+
+    # Initialize extensions
+    socketio.init_app(app)
+    login_manager.init_app(app)
+    login_manager.login_view = "auth.login"
+    db.init_app(app)
+
+    # Create database tables
+    with app.app_context():
+        db.create_all()
+
+    # Additional setup
+    utils.create_gui_dir(app.config['OUTPUT_FOLDER'])
+
+    # logger_list = app.config["LOGGERS"]
+    logger_path = os.path.join(app.config["OUTPUT_FOLDER"], app.config["LOGGERS_PATH"])
+    logger = utils.start_logger(socketio, 'gui_logger', logger_path)
+
+    @app.before_request
+    def before_request():
+        from flask import g
+        g.logger = logger
+        g.socketio = socketio
+
+    app.register_blueprint(main)
+    app.register_blueprint(auth)
+    app.register_blueprint(design)
+    app.register_blueprint(database)
+    app.register_blueprint(control)
+
+    return app
+
+
+def run(module=None, host="0.0.0.0", port=None, debug=None, llm_server=None, model=None,
+        config: Config = None,
+        logger: Union[str, list] = None,
+        logger_output_name: str = None,
+        ):
+    app = create_app(config_class=config or get_config())  # Create app instance using factory function
+
+    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
+    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_variables = utils.parse_deck(global_config.deck, output_path=app.config["DUMMY_DECK"], save=True)
+        # global_config.runner = ScriptRunner(globals())
+    else:
+        app.config["OFF_LINE"] = True
+    if model:
+        app.config["ENABLE_LLM"] = True
+        app.config["LLM_MODEL"] = model
+        app.config["LLM_SERVER"] = llm_server
+        utils.install_and_import('openai')
+        from ivoryos.utils.llm_agent import LlmAgent
+        global_config.agent = LlmAgent(host=llm_server, model=model,
+                                       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)
+    socketio.run(app, host=host, port=port, debug=debug, use_reloader=False, allow_unsafe_werkzeug=True)

ivoryos/config.py

@@ -0,0 +1,46 @@
+import os
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()
+
+
+class Config:
+    SECRET_KEY = os.getenv('SECRET_KEY', 'default_secret_key')
+    OPENAI_API_KEY = os.getenv('OPENAI_API_KEY', None)
+
+    OUTPUT_FOLDER = os.path.join(os.path.abspath(os.curdir), 'ivoryos_data')
+    os.makedirs(OUTPUT_FOLDER, exist_ok=True)
+    CSV_FOLDER = os.path.join(OUTPUT_FOLDER, 'config_csv/')
+    SCRIPT_FOLDER = os.path.join(OUTPUT_FOLDER, 'scripts/')
+    DATA_FOLDER = os.path.join(OUTPUT_FOLDER, 'results/')
+    DUMMY_DECK = os.path.join(OUTPUT_FOLDER, 'pseudo_deck/')
+    DECK_HISTORY = os.path.join(OUTPUT_FOLDER, 'deck_history.txt')
+    LOGGERS_PATH = "default.log"
+
+    SQLALCHEMY_DATABASE_URI = f"sqlite:///{os.path.join(OUTPUT_FOLDER, 'ivoryos.db')}"
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
+
+    ENABLE_LLM = True if OPENAI_API_KEY else False
+    OFF_LINE = True
+
+
+class DevelopmentConfig(Config):
+    DEBUG = True
+
+
+class ProductionConfig(Config):
+    DEBUG = False
+
+
+class TestingConfig(Config):
+    DEBUG = True
+    TESTING = True
+
+
+def get_config(env='dev'):
+    if env == 'production':
+        return ProductionConfig()
+    elif env == 'testing':
+        return TestingConfig()
+    return DevelopmentConfig()

ivoryos/routes/auth/auth.py

@@ -0,0 +1,65 @@
+from flask import Blueprint, redirect, url_for, flash, request, render_template, session
+from flask_login import login_required, login_user, logout_user, LoginManager
+import bcrypt
+
+from ivoryos.utils.db_models import Script, User, db
+from ivoryos.utils.utils import post_script_file
+login_manager = LoginManager()
+
+auth = Blueprint('auth', __name__, template_folder='templates/auth')
+
+
+@auth.route('/login', methods=['GET', 'POST'])
+def login():
+    if request.method == 'POST':
+        username = request.form.get('username')
+        password = request.form.get('password')
+
+        # session.query(User, User.name).all()
+        user = db.session.query(User).filter(User.username == username).first()
+        input_password = password.encode('utf-8')
+        # if user and bcrypt.checkpw(input_password, user.hashPassword.encode('utf-8')):
+        if user and bcrypt.checkpw(input_password, user.hashPassword):
+            # password.encode("utf-8")
+            # user = User(username, password.encode("utf-8"))
+            login_user(user)
+            session['user'] = username
+            script_file = Script(author=username)
+            session["script"] = script_file.as_dict()
+            session['hidden_functions'], session['card_order'], session['prompt'] = {}, {}, {}
+            session['autofill'] = False
+            post_script_file(script_file)
+            return redirect(url_for('main.index'))
+        else:
+            flash("Incorrect username or password")
+    return render_template('login.html')
+
+
+@auth.route('/signup', methods=['GET', 'POST'])
+def signup():
+    if request.method == 'POST':
+        username = request.form.get('username')
+        password = request.form.get('password')
+        salt = bcrypt.gensalt()
+        hashed = bcrypt.hashpw(password.encode('utf-8'), salt)
+        user = User(username, hashed)
+        try:
+            db.session.add(user)
+            db.session.commit()
+            return redirect(url_for('auth.login'))
+        except Exception:
+            flash("username exists :(")
+    return render_template('signup.html')
+
+
+@auth.route("/logout")
+@login_required
+def logout():
+    logout_user()
+    session.clear()
+    return redirect(url_for('auth.login'))
+
+
+@login_manager.user_loader
+def load_user(username):
+    return User(username, password=None)

ivoryos/routes/auth/templates/auth/login.html

@@ -0,0 +1,25 @@
+{% extends 'base.html' %}
+{% block title %}IvoryOS | Login{% endblock %}
+
+
+{% block body %}
+    <div class= "login">
+        <div class="bg-white rounded shadow-sm flex-fill">
+            <div class="p-4" style="align-items: center">
+                <h5>Log in</h5>
+                <form role="form" method='POST' name="login" action="{{ url_for('auth.login') }}">
+                    <div class="input-group mb-3">
+                        <label class="input-group-text" for="username">Username</label>
+                        <input class="form-control" type="text" id="username" name="username">
+                    </div>
+                    <div class="input-group mb-3">
+                        <label class="input-group-text" for="password">Password</label>
+                        <input class="form-control" type="password" id="password" name="password">
+                    </div>
+                    <button type="submit" class="btn btn-secondary" name="login" style="width: 100%;">login</button>
+                </form>
+                <p class="message">Not registered? <a href="{{ url_for('auth.signup') }}">Create a new account</a>
+            </div>
+        </div>
+    </div>
+{% endblock %}

ivoryos/routes/auth/templates/auth/signup.html

@@ -0,0 +1,32 @@
+{% extends 'base.html' %}
+{% block title %}IvoryOS | Signup{% endblock %}
+
+
+{% block body %}
+<div class= "login">
+    <div class="bg-white rounded shadow-sm flex-fill">
+        <div class="p-4" style="align: center">
+            <h5>Create a new account</h5>
+            <form role="form" method='POST' name="signup" action="{{ url_for('auth.signup') }}">
+
+                <div class="input-group mb-3">
+                    <label class="input-group-text" for="username">Username</label>
+                    <input class="form-control" type="text" id="username" name="username" required>
+                </div>
+                <div class="input-group mb-3">
+                    <label class="input-group-text" for="password">Password</label>
+                    <input class="form-control" type="password" id="password" name="password" required>
+                </div>
+{#                <div class="input-group mb-3">#}
+{#                    <label class="input-group-text" for="confirm_password">Confirm Password</label>#}
+{#                    <input class="form-control" type="confirm_password" id="confirm_password" name="confirm_password">#}
+{#                </div>#}
+
+                <button type="submit" class="btn btn-secondary" name="login" style="width: 100%;">Sign up</button>
+            </form>
+            <p class="message" >Already registered? <a href="{{ url_for('auth.login') }}">Sign In</a></p>
+        </div>
+    </div>
+</div>
+
+{% endblock %}

ivoryos/routes/control/control.py

@@ -0,0 +1,233 @@
+import os
+import pickle
+import sys
+
+from flask import Blueprint, redirect, url_for, flash, request, render_template, session, current_app
+from flask_login import login_required
+
+from ivoryos.utils.global_config import GlobalConfig
+from ivoryos.utils import utils
+from ivoryos.utils.form import create_form_from_module, format_name
+
+global_config = GlobalConfig()
+
+control = Blueprint('control', __name__, template_folder='templates/control')
+
+
+@control.route("/my_deck")
+@login_required
+def deck_controllers():
+    deck_variables = global_config.deck_variables.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'])
+@login_required
+def new_controller(instrument=None):
+    device = None
+    args = None
+    if instrument:
+
+        device = find_instrument_by_name(instrument)
+        args = utils.inspect.signature(device.__init__)
+
+        if request.method == 'POST':
+            device_name = request.form.get("device_name", "")
+            if device_name and device_name in globals():
+                flash("Device name is defined. Try another name, or leave it as blank to auto-configure")
+                return render_template('controllers_new.html', instrument=instrument,
+                                       api_variables=global_config.api_variables,
+                                       device=device, args=args, defined_variables=global_config.defined_variables)
+            if device_name == "":
+                device_name = device.__name__.lower() + "_"
+                num = 1
+                while device_name + str(num) in global_config.defined_variables:
+                    num += 1
+                device_name = device_name + str(num)
+            kwargs = request.form.to_dict()
+            kwargs.pop("device_name")
+            for i in kwargs:
+                if kwargs[i] in global_config.defined_variables:
+                    kwargs[i] = global_config.defined_variables[kwargs[i]]
+            try:
+                utils.convert_config_type(kwargs, device.__init__.__annotations__, is_class=True)
+            except Exception as e:
+                flash(e)
+            try:
+                global_config.defined_variables[device_name] = device(**kwargs)
+                # global_config.defined_variables.add(device_name)
+                return redirect(url_for('control.controllers_home'))
+            except Exception as e:
+                flash(e)
+    return render_template('controllers_new.html', instrument=instrument, api_variables=global_config.api_variables,
+                           device=device, args=args, defined_variables=global_config.defined_variables)
+
+
+@control.route("/controllers")
+@login_required
+def controllers_home():
+    # defined_variables = parse_deck(deck)
+    return render_template('controllers_home.html', defined_variables=global_config.defined_variables)
+
+
+@control.route("/controllers/<instrument>", methods=['GET', 'POST'])
+@login_required
+def controllers(instrument):
+    inst_object = find_instrument_by_name(instrument)
+    _forms = create_form_from_module(sdl_module=inst_object, autofill=False, design=False)
+    card_order = session.get('card_order')
+    order = card_order.get(instrument, _forms.keys())
+    if instrument not in card_order:
+        card_order[instrument] = list(order)
+        session['card_order'] = card_order
+        # print(session['card_order'])
+    forms = {name: _forms[name] for name in order if name in _forms}
+    if request.method == 'POST':
+        all_kwargs = request.form.copy()
+        method_name = all_kwargs.pop("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'}
+        function_executable = getattr(inst_object, method_name)
+        if form and form.validate_on_submit():
+            try:
+                kwargs.pop("hidden_name")
+                output = function_executable(**kwargs)
+                flash(f"\nRun Success! Output value: {output}.")
+            except Exception as e:
+                flash(e.__str__())
+        else:
+            flash(form.errors)
+    return render_template('controllers.html', instrument=instrument, forms=forms, format_name=format_name)
+
+
+@control.route("/import_api", methods=['GET', 'POST'])
+def import_api():
+    filepath = request.form.get('filepath')
+    # filepath.replace('\\', '/')
+    name = os.path.split(filepath)[-1].split('.')[0]
+    try:
+        spec = utils.importlib.util.spec_from_file_location(name, filepath)
+        module = utils.importlib.util.module_from_spec(spec)
+        spec.loader.exec_module(module)
+        classes = utils.inspect.getmembers(module, utils.inspect.isclass)
+        if len(classes) == 0:
+            flash("Invalid import: no class found in the path")
+            return redirect(url_for("control.controllers_home"))
+        for i in classes:
+            globals()[i[0]] = i[1]
+            global_config.api_variables.add(i[0])
+    # should handle path error and file type error
+    except Exception as e:
+        flash(e.__str__())
+    return redirect(url_for("control.new_controller"))
+
+
+# @control.route("/disconnect", methods=["GET"])
+# @control.route("/disconnect/<device_name>", methods=["GET"])
+# def disconnect(device_name=None):
+#     """TODO handle disconnect device"""
+#     if device_name:
+#         try:
+#             exec(device_name + ".disconnect()")
+#         except Exception:
+#             pass
+#         global_config.defined_variables.remove(device_name)
+#         globals().pop(device_name)
+#         return redirect(url_for('control.controllers_home'))
+#
+#     deck_variables = ["deck." + var for var in set(dir(deck))
+#                       if not (var.startswith("_") or var[0].isupper() or var.startswith("repackage"))
+#                       and not type(eval("deck." + var)).__module__ == 'builtins']
+#     for i in deck_variables:
+#         try:
+#             exec(i + ".disconnect()")
+#         except Exception:
+#             pass
+#     globals()["deck"] = None
+#     return redirect(url_for('control.deck_controllers'))
+
+
+@control.route("/import_deck", methods=['POST'])
+def import_deck():
+    # global deck
+    script = utils.get_script_file()
+    filepath = request.form.get('filepath')
+    session['dismiss'] = request.form.get('dismiss')
+    update = request.form.get('update')
+    back = request.referrer
+    if session['dismiss']:
+        return redirect(back)
+    name = os.path.split(filepath)[-1].split('.')[0]
+    try:
+        module = utils.import_module_by_filepath(filepath=filepath, name=name)
+        utils.save_to_history(filepath, current_app.config["DECK_HISTORY"])
+        module_sigs = utils.parse_deck(module, save=update, output_path=current_app.config["DUMMY_DECK"])
+        if not len(module_sigs) > 0:
+            flash("Invalid hardware deck, connect instruments in deck script", "error")
+            return redirect(url_for("control.deck_controllers"))
+        global_config.deck = module
+        global_config.deck_variables = module_sigs
+
+        if script.deck is None:
+            script.deck = module.__name__
+    # file path error exception
+    except Exception as e:
+        flash(e.__str__())
+    return redirect(back)
+
+
+@control.route('/save-order/<instrument>', methods=['POST'])
+def save_order(instrument):
+    # Save the new order for the specified group to session
+    data = request.json
+    card_order = session.get("card_order", {})
+    card_order[instrument] = data['order']
+    session['card_order'] = card_order
+    return '', 204
+
+
+@control.route('/hide_function/<instrument>/<function>')
+def hide_function(instrument, function):
+    back = request.referrer
+    hidden_functions = session.get("hidden_functions")
+    functions = hidden_functions.get(instrument, [])
+    card_order = session.get("card_order")
+    order = card_order.get(instrument)
+    if function not in functions:
+        functions.append(function)
+        order.remove(function)
+    hidden_functions[instrument] = functions
+    card_order[instrument] = order
+    session['hidden_functions'] = hidden_functions
+    session['card_order'] = card_order
+    return redirect(back)
+
+
+@control.route('/remove_hidden/<instrument>/<function>')
+def remove_hidden(instrument, function):
+    back = request.referrer
+    hidden_functions = session.get("hidden_functions")
+    functions = hidden_functions.get(instrument, [])
+    card_order = session.get("card_order")
+    order = card_order.get(instrument)
+    if function in functions:
+        functions.remove(function)
+        order.append(function)
+    hidden_functions[instrument] = functions
+    card_order[instrument] = order
+    session['hidden_functions'] = hidden_functions
+    session['card_order'] = card_order
+    return redirect(back)
+
+
+def find_instrument_by_name(name: str):
+    if name.startswith("deck"):
+        name = name.replace("deck.", "")
+        return getattr(global_config.deck, name)
+    elif name in global_config.defined_variables:
+        return global_config.defined_variables[name]
+    elif name in globals():
+        return globals()[name]

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

@@ -0,0 +1,71 @@
+{% extends 'base.html' %}
+{% block title %}IvoryOS | Controller for {{instrument}}{% endblock %}
+{% block body %}
+    <div id="overlay" class="overlay">
+        <div>
+            <h3 id="overlay-text"></h3>
+            <div class="spinner-border" role="status"></div>
+        </div>
+    </div>
+    <h1>{{instrument}} controller</h1>
+    <div class="grid-container" id="sortable-grid">
+        {% for function, form in forms.items() %}
+            {% if function not in session['hidden_functions'][instrument] %}
+                <div class="card" id="{{function}}">
+                    <div class="bg-white rounded shadow-sm flex-fill">
+                        <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}}">
+                                <div class="form-group">
+                                    {{ form.hidden_tag() }}
+                                    {% for field in form %}
+                                        {% if field.type not in ['CSRFTokenField', 'HiddenField'] %}
+                                            <div class="input-group mb-3">
+                                                <label class="input-group-text">{{ field.label.text }}</label>
+                                                {% if field.type == "SubmitField" %}
+                                                    {{ field(class="btn btn-dark") }}
+                                                {% elif field.type == "BooleanField" %}
+                                                    {{ field(class="form-check-input") }}
+                                                {% else %}
+                                                    {{ field(class="form-control") }}
+                                                {% endif %}
+                                            </div>
+                                        {% endif %}
+                                    {% endfor %}
+                                </div>
+                                <div class="input-group mb-3">
+                                    <button type="submit" name="{{ function }}" id="{{ function }}" class="form-control" style="background-color: #a5cece;">{{function}} </button>
+                                </div>
+                            </form>
+                        </div>
+                    </div>
+                </div>
+            {% endif %}
+        {% endfor %}
+    </div>
+    <div class="accordion accordion-flush" id="accordionActions" >
+        <div class="accordion-item">
+            <h4 class="accordion-header">
+                <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#hidden">
+                    Hidden functions
+                </button>
+            </h4>
+        </div>
+        <div id="hidden" class="accordion-collapse collapse" data-bs-parent="#accordionActions">
+            <div class="accordion-body">
+                {% for function in session['hidden_functions'][instrument] %}
+                    <div>
+                        {{ function }} <a href="{{ url_for('control.remove_hidden', instrument=instrument, function=function) }}"><i class="bi bi-eye-fill"></i></a>
+                    </div>
+                {% endfor %}
+            </div>
+        </div>
+    </div>
+
+    <script>
+        const saveOrderUrl = `{{ url_for('control.save_order', instrument=instrument) }}`;
+        const buttonIds = {{ session['card_order'][instrument] | tojson }};
+    </script>
+    <script src="{{ url_for('static', filename='js/sortable_card.js') }}"></script>
+    <script src="{{ url_for('static', filename='js/overlay.js') }}"></script>
+{% endblock %}

ivoryos/routes/control/templates/control/controllers_home.html

@@ -0,0 +1,50 @@
+{% extends 'base.html' %}
+{% block title %}IvoryOS | Devices{% endblock %}
+{% block body %}
+    <div class="row">
+    {% if defined_variables %}
+        {% 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 %}#}
+{#                        <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}}</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 %}#}
+                </div>
+            </div>
+        {% endfor %}
+        {% if not deck %}
+            <div class="col-xl-3 col-lg-4 col-md-6 mb-4 ">
+                <div class="bg-white rounded shadow-sm position-relative">
+                    <div class="p-4 controller-card" >
+                        {% if deck %}
+{#                            todo disconnect for imported deck #}
+{#                            <h5> <a href="{{ url_for("disconnect") }}" class="stretched-link" style="color: orangered">Disconnect deck</a></h5>#}
+                        {% else %}
+                            <h5><a href="{{ url_for('control.new_controller') }}" style="color: orange" class="stretched-link">New connection</a></h5>
+                        {% endif %}
+                    </div>
+                </div>
+            </div>
+        {% endif %}
+    {% else %}
+        <div class="col-xl-3 col-lg-4 col-md-6 mb-4 ">
+            <div class="bg-white rounded shadow-sm position-relative">
+                <div class="p-4 controller-card" >
+                    {% if deck %}
+                        <h5><a data-bs-toggle="modal" href="#importModal" class="stretched-link"><i class="bi bi-folder-plus"></i> Import deck </a></h5>
+                    {% else %}
+                        <h5><a href="{{ url_for('control.new_controller') }}" style="color: orange" class="stretched-link">New connection</a></h5>
+                    {% endif %}
+                </div>
+            </div>
+        </div>
+    {% endif %}
+    </div>
+{% endblock %}