ivoryos 0.1.8__py3-none-any.whl → 0.1.10__py3-none-any.whl

ivoryos/__init__.py

@@ -1,99 +1,118 @@
-import os
-import sys
-from typing import Union
-
-from flask import Flask, redirect, url_for
-
-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):
-    url_prefix = os.getenv('URL_PREFIX', "/ivoryos")
-    app = Flask(__name__, static_url_path=f'{url_prefix}/static', static_folder='static')
-    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, 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)
-
-    @app.route('/')
-    def redirect_to_prefix():
-        return redirect(url_for('main.index'))  # Assuming 'index' is a route in your blueprint
-
-    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_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
-    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)
+import os
+import sys
+from typing import Union
+
+from flask import Flask, redirect, url_for
+
+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
+from ivoryos.version import __version__ as ivoryos_version
+
+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")
+    # app = Flask(__name__, static_url_path=f'{url_prefix}/static', static_folder='static')
+    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.route('/')
+    def redirect_to_prefix():
+        return redirect(url_for('main.index', version=ivoryos_version))  # Assuming 'index' is a route in your blueprint
+
+    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,
+        ):
+    """
+    Start ivoryOS app server.
+
+    :param module: module name, __name__ for current module
+    :param host: host address, defaults to 0.0.0.0
+    :param port: port, defaults to None, and will use 8000
+    :param debug: debug mode, defaults to None (True)
+    :param llm_server: llm server, defaults to None.
+    :param model: llm model, defaults to None. If None, app will run without text-to-code feature
+    :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"
+
+    """
+    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_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
+    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

@@ -1,47 +1,47 @@
-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/')
-    LLM_OUTPUT = os.path.join(OUTPUT_FOLDER, 'llm_output/')
-    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()
+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/')
+    LLM_OUTPUT = os.path.join(OUTPUT_FOLDER, 'llm_output/')
+    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

@@ -1,65 +1,100 @@
-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)
+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():
+    """
+    .. :quickref: User; login user
+
+    .. http:get:: /login
+
+    load user login form.
+
+    .. http:post:: /login
+
+    :form username: username
+    :form password: password
+    :status 302: and then redirects to homepage
+    :status 401: incorrect password, redirects to :http:get:`/ivoryos/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 redirect(url_for('auth.login')), 401
+    return render_template('login.html')
+
+
+@auth.route('/signup', methods=['GET', 'POST'])
+def signup():
+    """
+    .. :quickref: User; signup for a new account
+
+    .. http:get:: /signup
+
+    load user sighup
+
+    .. http:post:: /signup
+
+    :form username: username
+    :form password: password
+    :status 302: and then redirects to :http:get:`/ivoryos/login`
+    :status 409: when user already exists, redirects to :http:get:`/ivoryos/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 :(", "error")
+            return render_template('signup.html'), 409
+    return render_template('signup.html')
+
+
+@auth.route("/logout")
+@login_required
+def logout():
+    """
+    .. :quickref: User; logout the user
+
+    logout the current user, clear session info, and redirect to the login page.
+    """
+    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

@@ -1,25 +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 %}
+{% 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

@@ -1,32 +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 %}
+{% 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 %}