plugin_list.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "vscode": {
     "languageId": "javascript"
    }
   },
   "outputs": [],
   "source": [
    "%%javascript\n",
    "IPython.OutputArea.prototype._should_scroll = function(lines) {\n",
    "    return false;\n",
    "}\n",
    "document.title='AiiDAlab QE | Manage plugins'"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "%%capture\n",
    "from aiida import load_profile\n",
    "\n",
    "load_profile()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from aiidalab_widgets_base.utils.loaders import load_css\n",
    "\n",
    "load_css(css_path=\"src/aiidalab_qe/app/static/styles\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# AiiDAlab Quantum ESPRESSO - Plugin manager\n",
    "\n",
    "This page lets you manage the plugins of the AiiDAlab Quantum ESPRESSO app. You can find below all plugins available in the official [AiiDAlab Quantum ESPRESSO plugin registry](https://github.com/aiidalab/aiidalab-qe/blob/main/plugins.yaml) (click [here](https://aiidalab-qe.readthedocs.io/development/plugin_registry.html) to learn how to register a new plugin, if you are developing one). You can install and uninstall plugins from this page.\n",
    "\n",
    "\n",
    "### Available plugins\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from pathlib import Path\n",
    "\n",
    "import yaml\n",
    "\n",
    "# Get the current working directory\n",
    "cwd = Path.cwd()\n",
    "# Define a relative path\n",
    "relative_path = \"plugins.yaml\"\n",
    "# Resolve the relative path to an absolute path\n",
    "yaml_file = cwd / relative_path\n",
    "\n",
    "# Load the YAML content\n",
    "with yaml_file.open(\"r\") as file:\n",
    "    data = yaml.safe_load(file)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import subprocess\n",
    "import sys\n",
    "from threading import Thread\n",
    "\n",
    "import ipywidgets as ipw\n",
    "from IPython.display import display\n",
    "\n",
    "\n",
    "def is_package_installed(package_name):\n",
    "    import importlib\n",
    "\n",
    "    package_name = package_name.replace(\"-\", \"_\")\n",
    "    try:\n",
    "        importlib.import_module(package_name)\n",
    "    except ImportError:\n",
    "        return False\n",
    "    else:\n",
    "        return True\n",
    "\n",
    "\n",
    "def stream_output(process, output_widget):\n",
    "    \"\"\"Reads output from the process and forwards it to the output widget.\"\"\"\n",
    "    while True:\n",
    "        output = process.stdout.readline()\n",
    "        if process.poll() is not None and output == \"\":\n",
    "            break\n",
    "        if output:\n",
    "            output_widget.value += f\"\"\"<div style=\"background-color: #3B3B3B; color: #FFFFFF;\">{output}</div>\"\"\"\n",
    "\n",
    "\n",
    "def execute_command_with_output(\n",
    "    command, output_widget, install_btn, remove_btn, action=\"install\"\n",
    "):\n",
    "    \"\"\"Execute a command and stream its output to the given output widget.\"\"\"\n",
    "    output_widget.value = \"\"  # Clear the widget\n",
    "    process = subprocess.Popen(\n",
    "        command, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True, bufsize=1\n",
    "    )\n",
    "    # Create a thread to read the output stream and write it to the output widget\n",
    "    thread = Thread(target=stream_output, args=(process, output_widget))\n",
    "    thread.start()\n",
    "    thread.join()  # Wait for the thread to finish\n",
    "\n",
    "    if process.returncode == 0 and action == \"install\":\n",
    "        install_btn.disabled = True\n",
    "        remove_btn.disabled = False\n",
    "        return True\n",
    "    elif process.returncode == 0 and action == \"remove\":\n",
    "        install_btn.disabled = False\n",
    "        remove_btn.disabled = True\n",
    "        return True\n",
    "    else:\n",
    "        output_widget.value += \"\"\"<div style=\"background-color: #3B3B3B; color: #FF0000;\">Command failed.</div>\"\"\"\n",
    "        return False\n",
    "\n",
    "\n",
    "def install_package(\n",
    "    package_name,\n",
    "    pip,\n",
    "    github,\n",
    "    post_install,\n",
    "    output_container,\n",
    "    message_container,\n",
    "    install_btn,\n",
    "    remove_btn,\n",
    "    accordion,\n",
    "    index,\n",
    "):\n",
    "    if pip:\n",
    "        command = [\"pip\", \"install\", pip, \"--user\"]\n",
    "    else:\n",
    "        command = [\"pip\", \"install\", \"git+\" + github, \"--user\"]\n",
    "    message_container.value = (\n",
    "        f\"\"\"<div style=\"color: #000000;\">Installing {package_name}...</div>\"\"\"\n",
    "    )\n",
    "    result = execute_command_with_output(\n",
    "        command, output_container, install_btn, remove_btn\n",
    "    )\n",
    "    # Execute post install if defined in the plugin.yaml:\n",
    "    if post_install:\n",
    "        message_container.value += (\n",
    "            \"\"\"<div style=\"color: #008000;\">Post installation step...</div>\"\"\"\n",
    "        )\n",
    "        command = [sys.executable, \"-m\", package_name.replace(\"-\", \"_\"), post_install]\n",
    "        # Execute the command\n",
    "        result = subprocess.run(command, capture_output=True, text=True, check=False)\n",
    "    # if the package was installed successfully\n",
    "    if result:\n",
    "        message_container.value += \"\"\"<div style=\"color: #008000;\">Initiating test to load the plugin...</div>\"\"\"\n",
    "        # Test plugin functionality\n",
    "        command = [sys.executable, \"-m\", \"aiidalab_qe\", \"test-plugin\", package_name]\n",
    "        # Execute the command\n",
    "        result = subprocess.run(command, capture_output=True, text=True, check=False)\n",
    "        if result.returncode == 0:\n",
    "            # restart daemon\n",
    "            message_container.value = (\n",
    "                \"\"\"<div style=\"color: #008000;\">Loading plugin test passed.</div>\"\"\"\n",
    "            )\n",
    "            message_container.value += (\n",
    "                \"\"\"<div style=\"color: #008000;\">Plugin installed successfully.</div>\"\"\"\n",
    "            )\n",
    "            accordion.set_title(index, f\"{accordion.get_title(index)[:-2]} ✅\")\n",
    "            command = [\"verdi\", \"daemon\", \"restart\"]\n",
    "            subprocess.run(command, capture_output=True, shell=False, check=False)\n",
    "        else:\n",
    "            # uninstall the package\n",
    "            message_container.value = f\"\"\"<div style=\"color: #FF0000;\">The plugin '{package_name}' was installed successfully but plugin functionality test failed: {result.stderr}. </div>\"\"\"\n",
    "            message_container.value += \"\"\"<div style=\"color: #FF0000;\">This may be due to compatibility issues with the current AiiDAlab QEApp version. Please contact the plugin author for further assistance.</div>\"\"\"\n",
    "            message_container.value += \"\"\"<div style=\"color: #FF0000;\">To prevent potential issues, the plugin will now be uninstalled.</div>\"\"\"\n",
    "            remove_package(\n",
    "                package_name,\n",
    "                output_container,\n",
    "                message_container,\n",
    "                install_btn,\n",
    "                remove_btn,\n",
    "                accordion,\n",
    "                index,\n",
    "            )\n",
    "\n",
    "\n",
    "def remove_package(\n",
    "    package_name,\n",
    "    output_container,\n",
    "    message_container,\n",
    "    install_btn,\n",
    "    remove_btn,\n",
    "    accordion,\n",
    "    index,\n",
    "):\n",
    "    message_container.value += (\n",
    "        f\"\"\"<div style=\"color: #FF0000;\">Removing {package_name}...</div>\"\"\"\n",
    "    )\n",
    "    package_name = package_name.replace(\"-\", \"_\")\n",
    "    command = [\"pip\", \"uninstall\", \"-y\", package_name]\n",
    "    result = execute_command_with_output(\n",
    "        command, output_container, install_btn, remove_btn, action=\"remove\"\n",
    "    )\n",
    "    if result:\n",
    "        message_container.value += f\"\"\"<div style=\"color: #008000;\">{package_name} removed successfully.</div>\"\"\"\n",
    "        accordion.set_title(index, f\"{accordion.get_title(index)[:-2]} ☐\")\n",
    "        command = [\"verdi\", \"daemon\", \"restart\"]\n",
    "        subprocess.run(command, capture_output=True, shell=False, check=False)\n",
    "\n",
    "\n",
    "def run_remove_button(\n",
    "    package_name,\n",
    "    output_container,\n",
    "    message_container,\n",
    "    install_btn,\n",
    "    remove_btn,\n",
    "    accordion,\n",
    "    index,\n",
    "):\n",
    "    message_container.value = \"\"\n",
    "    remove_package(\n",
    "        package_name,\n",
    "        output_container,\n",
    "        message_container,\n",
    "        install_btn,\n",
    "        remove_btn,\n",
    "        accordion,\n",
    "        index,\n",
    "    )\n",
    "\n",
    "\n",
    "accordion = ipw.Accordion()\n",
    "\n",
    "for i, (plugin_name, plugin_data) in enumerate(data.items()):\n",
    "    installed = is_package_installed(plugin_name)\n",
    "\n",
    "    # Output container with customized styling\n",
    "    output_container = ipw.HTML(\n",
    "        value=\"\"\"\n",
    "        <div style=\"background-color: #3B3B3B; color: #FFFFFF; height: 100%; overflow: auto;\">\n",
    "        </div>\n",
    "        \"\"\",\n",
    "        layout=ipw.Layout(\n",
    "            max_height=\"250px\", overflow=\"auto\", border=\"2px solid #CCCCCC\"\n",
    "        ),\n",
    "    )\n",
    "    # Output container with customized styling\n",
    "    message_container = ipw.HTML(\n",
    "        value=\"\"\"\n",
    "        <div style=\"color: #000000; height: 100%; overflow: auto;\">\n",
    "        </div>\n",
    "        \"\"\",\n",
    "        layout=ipw.Layout(\n",
    "            max_height=\"250px\", overflow=\"auto\", border=\"2px solid #CCCCCC\"\n",
    "        ),\n",
    "    )\n",
    "\n",
    "    details = (\n",
    "        f\"Author: {plugin_data.get('author', 'N/A')}<br>\"\n",
    "        f\"Description: {plugin_data.get('description', 'No description available')}<br>\"\n",
    "    )\n",
    "    if \"documentation\" in plugin_data:\n",
    "        details += f\"Documentation: <a href='{plugin_data['documentation']}' target='_blank'>Visit</a><br>\"\n",
    "    if \"github\" in plugin_data:\n",
    "        details += (\n",
    "            f\"Github: <a href='{plugin_data.get('github')}' target='_blank'>Visit</a>\"\n",
    "        )\n",
    "\n",
    "    install_btn = ipw.Button(\n",
    "        description=\"Install\", button_style=\"success\", disabled=installed\n",
    "    )\n",
    "    remove_btn = ipw.Button(\n",
    "        description=\"Remove\", button_style=\"danger\", disabled=not installed\n",
    "    )\n",
    "\n",
    "    install_btn.on_click(\n",
    "        lambda _btn,\n",
    "        pn=plugin_name,\n",
    "        pip=plugin_data.get(\"pip\", None),  # noqa: B008\n",
    "        github=plugin_data.get(\"github\", \"\"),  # noqa: B008\n",
    "        post=plugin_data.get(\"post_install\", None),  # noqa: B008\n",
    "        oc=output_container,\n",
    "        mc=message_container,\n",
    "        ib=install_btn,\n",
    "        rb=remove_btn,\n",
    "        ac=accordion,\n",
    "        index=i: install_package(pn, pip, github, post, oc, mc, ib, rb, ac, index)\n",
    "    )\n",
    "    remove_btn.on_click(\n",
    "        lambda _btn,\n",
    "        pn=plugin_name,\n",
    "        oc=output_container,\n",
    "        mc=message_container,\n",
    "        ib=install_btn,\n",
    "        rb=remove_btn,\n",
    "        ac=accordion,\n",
    "        index=i: run_remove_button(pn, oc, mc, ib, rb, ac, index)\n",
    "    )\n",
    "\n",
    "    box = ipw.VBox(\n",
    "        [\n",
    "            ipw.HTML(details),\n",
    "            ipw.HBox([install_btn, remove_btn]),\n",
    "            message_container,\n",
    "            output_container,\n",
    "        ]\n",
    "    )\n",
    "\n",
    "    title_with_icon = f\"{plugin_data.get('title')} {'✅' if installed else '☐'}\"\n",
    "    accordion.set_title(i, title_with_icon)\n",
    "    accordion.children = [*accordion.children, box]\n",
    "\n",
    "display(accordion)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "base",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.13"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}