gradio-terminal 0.1.0__tar.gz

gradio_terminal-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Po-Hsuan Huang (aben20807)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

gradio_terminal-0.1.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: gradio-terminal
+Version: 0.1.0
+Summary: A Gradio component that provides a fully functional terminal using xterm.js and PTY
+Author: Po-Hsuan Huang
+Author-email: Po-Hsuan Huang <aben20807@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/aben20807/gradio-terminal
+Project-URL: Repository, https://github.com/aben20807/gradio-terminal
+Project-URL: Issues, https://github.com/aben20807/gradio-terminal/issues
+Keywords: gradio,terminal,xterm,pty,shell
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gradio>=6.3.0
+Requires-Dist: flask>=3.1.2
+Requires-Dist: flask-socketio>=5.6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Dynamic: author
+Dynamic: license-file
+Dynamic: requires-python
+
+# Gradio Terminal
+
+A Gradio component that provides a fully functional terminal in your browser. This package uses xterm.js on the frontend and a PTY on the backend to provide a real shell experience.
+
+![Gradio Terminal](https://github.com/user-attachments/assets/8a4cc81a-07a4-4c56-a008-bd438eae50de)
+
+## Installation
+
+```bash
+pip install gradio-terminal
+```
+
+## Quick Start
+
+### Simple Usage
+
+```python
+import gradio as gr
+from gradio_terminal import Terminal
+demo = gr.Blocks()
+with demo:
+    terminal = Terminal()
+demo.launch()
+```
+
+## API Reference
+
+`launch_terminal(port=5000, host="127.0.0.1", command="bash", share=False, **launch_kwargs)`
+
+Launch a standalone Gradio app with a terminal.
+
+`create_terminal_demo(port=5000, host="127.0.0.1", command="bash", height=400)`
+
+Create a Gradio Blocks demo with an embedded terminal.
+
+`TerminalServer(port=5000, host="127.0.0.1", command="bash")`
+
+Low-level terminal server for custom integrations.
+
+- `start()`: Start the server and return the URL
+- `get_url()`: Get the terminal server URL
+- `stop()`: Stop the terminal server
+
+## Requirements
+
+- Python 3.8+
+- Linux
+- Dependencies: gradio, flask, flask-socketio
+
+## Security Notice
+
+This component provides shell access to your server. Use only in trusted environments.
+
+## License
+
+This project is licensed under the Apache-2.0 License.
+
+## Acknowledgments
+
+- [pyxtermjs](https://github.com/cs01/pyxtermjs) - Inspiration for the terminal implementation
+- [xterm.js](https://xtermjs.org/) - Terminal emulator for the browser
+- [Gradio](https://gradio.app/) - The awesome ML demo framework

gradio_terminal-0.1.0/README.md

@@ -0,0 +1,62 @@
+# Gradio Terminal
+
+A Gradio component that provides a fully functional terminal in your browser. This package uses xterm.js on the frontend and a PTY on the backend to provide a real shell experience.
+
+![Gradio Terminal](https://github.com/user-attachments/assets/8a4cc81a-07a4-4c56-a008-bd438eae50de)
+
+## Installation
+
+```bash
+pip install gradio-terminal
+```
+
+## Quick Start
+
+### Simple Usage
+
+```python
+import gradio as gr
+from gradio_terminal import Terminal
+demo = gr.Blocks()
+with demo:
+    terminal = Terminal()
+demo.launch()
+```
+
+## API Reference
+
+`launch_terminal(port=5000, host="127.0.0.1", command="bash", share=False, **launch_kwargs)`
+
+Launch a standalone Gradio app with a terminal.
+
+`create_terminal_demo(port=5000, host="127.0.0.1", command="bash", height=400)`
+
+Create a Gradio Blocks demo with an embedded terminal.
+
+`TerminalServer(port=5000, host="127.0.0.1", command="bash")`
+
+Low-level terminal server for custom integrations.
+
+- `start()`: Start the server and return the URL
+- `get_url()`: Get the terminal server URL
+- `stop()`: Stop the terminal server
+
+## Requirements
+
+- Python 3.8+
+- Linux
+- Dependencies: gradio, flask, flask-socketio
+
+## Security Notice
+
+This component provides shell access to your server. Use only in trusted environments.
+
+## License
+
+This project is licensed under the Apache-2.0 License.
+
+## Acknowledgments
+
+- [pyxtermjs](https://github.com/cs01/pyxtermjs) - Inspiration for the terminal implementation
+- [xterm.js](https://xtermjs.org/) - Terminal emulator for the browser
+- [Gradio](https://gradio.app/) - The awesome ML demo framework

gradio_terminal-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gradio-terminal"
+version = "0.1.0"
+description = "A Gradio component that provides a fully functional terminal using xterm.js and PTY"
+readme = "README.md"
+license = {text = "Apache-2.0"}
+authors = [
+    {name = "Po-Hsuan Huang", email = "aben20807@gmail.com"}
+]
+keywords = ["gradio", "terminal", "xterm", "pty", "shell"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "gradio>=6.3.0",
+    "flask>=3.1.2",
+    "flask-socketio>=5.6.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "black>=22.0.0",
+    "flake8>=4.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/aben20807/gradio-terminal"
+Repository = "https://github.com/aben20807/gradio-terminal"
+Issues = "https://github.com/aben20807/gradio-terminal/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.black]
+line-length = 100
+target-version = ["py38", "py39", "py310", "py311", "py312"]

gradio_terminal-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

gradio_terminal-0.1.0/setup.py

@@ -0,0 +1,32 @@
+from setuptools import find_packages, setup
+
+setup(
+    name="gradio-terminal",
+    version="0.1.0",
+    author="Po-Hsuan Huang",
+    author_email="aben20807@gmail.com",
+    description="A Gradio component that provides a fully functional terminal using xterm.js and PTY",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    packages=find_packages(where="src"),
+    package_dir={"": "src"},
+    license="Apache-2.0",
+    install_requires=[
+        "gradio>=6.3.0",
+        "flask>=3.1.2",
+        "flask-socketio>=5.6.0",
+    ],
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: Apache Software License",
+        "Operating System :: POSIX :: Linux",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+    ],
+    python_requires=">=3.8",
+)

gradio_terminal-0.1.0/src/gradio_terminal/__init__.py

@@ -0,0 +1,43 @@
+"""
+Gradio Terminal - A terminal component for Gradio.
+
+This package provides a fully functional terminal that can be embedded
+in Gradio applications. It uses xterm.js on the frontend and a PTY
+(pseudo-terminal) on the backend to provide a real shell experience.
+
+Example usage in Blocks:
+    import gradio as gr
+    from gradio_terminal import Terminal
+
+    with gr.Blocks() as demo:
+        gr.Markdown("# My App with Terminal")
+        with gr.Row():
+            with gr.Column():
+                gr.Markdown("Some content here")
+            with gr.Column():
+                terminal = Terminal()
+
+    demo.launch()
+
+Or for quick usage:
+    from gradio_terminal import launch_terminal
+
+    launch_terminal()
+"""
+
+from .terminal import (
+    Terminal,
+    TerminalServer,
+    create_terminal,
+    create_terminal_demo,
+    launch_terminal,
+)
+
+__version__ = "0.1.0"
+__all__ = [
+    "Terminal",
+    "TerminalServer",
+    "create_terminal",
+    "create_terminal_demo",
+    "launch_terminal",
+]

gradio_terminal-0.1.0/src/gradio_terminal/terminal.py

@@ -0,0 +1,523 @@
+"""
+Gradio Terminal Component using xterm.js and PTY.
+
+This component provides a fully functional terminal in Gradio applications.
+Based on pyxtermjs (https://github.com/cs01/pyxtermjs).
+
+IMPORTANT: If using SSH tunneling, you need to tunnel BOTH ports:
+- The Gradio port (default 7860)
+- The terminal server port (default 5000)
+
+Example SSH command:
+  ssh -L 7860:localhost:7860 -L 5000:localhost:5000 user@remote
+"""
+
+"""
+Include pyxtermjs's MIT license:
+
+MIT License
+
+Copyright (c) 2018 Chad Smith
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+import atexit
+import fcntl
+import logging
+import os
+import pty
+import select
+import shlex
+import signal
+import struct
+import subprocess
+import termios
+import threading
+import time
+from typing import Any
+
+import gradio as gr
+
+logging.getLogger("werkzeug").setLevel(logging.ERROR)
+
+# Global registry to track terminal servers
+_terminal_servers: dict[int, "TerminalServer"] = {}
+
+
+def _cleanup_servers():
+    """Clean up all terminal servers on exit."""
+    for server in list(_terminal_servers.values()):
+        try:
+            server.stop()
+        except Exception:
+            pass
+
+
+atexit.register(_cleanup_servers)
+
+
+class TerminalServer:
+    """
+    A server that manages PTY sessions for terminal access.
+    Runs Flask-SocketIO in a background thread.
+    """
+
+    def __init__(self, port: int = 5000, host: str = "127.0.0.1", command: str = "bash"):
+        self.port = port
+        self.host = host
+        self.command = command
+        self._running = False
+        self._thread = None
+        self._app = None
+        self._socketio = None
+
+        # Register in global registry
+        _terminal_servers[port] = self
+
+    def _create_app(self):
+        """Create and configure the Flask app with SocketIO."""
+        from flask import Flask, render_template_string
+        from flask_socketio import SocketIO
+
+        app = Flask(__name__)
+        app.config["SECRET_KEY"] = "gradio-terminal-secret"
+        app.config["fd"] = None
+        app.config["child_pid"] = None
+        app.config["cmd"] = shlex.split(self.command)
+
+        socketio = SocketIO(app, cors_allowed_origins="*", async_mode="threading")
+
+        def set_winsize(fd, row, col, xpix=0, ypix=0):
+            winsize = struct.pack("HHHH", row, col, xpix, ypix)
+            fcntl.ioctl(fd, termios.TIOCSWINSZ, winsize)
+
+        def read_and_forward_pty_output():
+            max_read_bytes = 1024 * 20
+            while True:
+                socketio.sleep(0.01)
+                if app.config["fd"]:
+                    timeout_sec = 0
+                    try:
+                        data_ready, _, _ = select.select([app.config["fd"]], [], [], timeout_sec)
+                        if data_ready:
+                            output = os.read(app.config["fd"], max_read_bytes).decode(
+                                errors="ignore"
+                            )
+                            socketio.emit("pty-output", {"output": output}, namespace="/pty")
+                    except (OSError, ValueError):
+                        break
+
+        @app.route("/")
+        def index():
+            return render_template_string(self._get_terminal_html())
+
+        @socketio.on("pty-input", namespace="/pty")
+        def pty_input(data):
+            if app.config["fd"]:
+                os.write(app.config["fd"], data["input"].encode())
+
+        @socketio.on("resize", namespace="/pty")
+        def resize(data):
+            if app.config["fd"]:
+                set_winsize(app.config["fd"], data["rows"], data["cols"])
+
+        @socketio.on("connect", namespace="/pty")
+        def connect():
+            if app.config["child_pid"]:
+                return
+
+            child_pid, fd = pty.fork()
+            if child_pid == 0:
+                subprocess.run(app.config["cmd"])
+            else:
+                app.config["fd"] = fd
+                app.config["child_pid"] = child_pid
+                set_winsize(fd, 24, 80)
+                socketio.start_background_task(target=read_and_forward_pty_output)
+
+        @socketio.on("disconnect", namespace="/pty")
+        def disconnect():
+            pass
+
+        return app, socketio
+
+    def _get_terminal_html(self) -> str:
+        """Return the HTML template for the terminal."""
+        return """
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8" />
+    <title>Gradio Terminal</title>
+    <style>
+        html, body {
+            margin: 0;
+            padding: 0;
+            height: 100%;
+            overflow: hidden;
+            background-color: #1e1e1e;
+        }
+        #terminal {
+            width: 100%;
+            height: 100%;
+        }
+        #status {
+            position: absolute;
+            top: 5px;
+            right: 10px;
+            font-size: 12px;
+            font-family: Arial, sans-serif;
+            z-index: 1000;
+        }
+        .connected {
+            background-color: #4CAF50;
+            color: white;
+            padding: 2px 8px;
+            border-radius: 3px;
+        }
+        .disconnected {
+            background-color: #f44336;
+            color: white;
+            padding: 2px 8px;
+            border-radius: 3px;
+        }
+        .connecting {
+            background-color: #ff9800;
+            color: white;
+            padding: 2px 8px;
+            border-radius: 3px;
+        }
+    </style>
+    <link rel="stylesheet" href="https://unpkg.com/xterm@4.11.0/css/xterm.css" />
+</head>
+<body>
+    <div id="status"><span class="connecting">connecting...</span></div>
+    <div id="terminal"></div>
+
+    <script src="https://unpkg.com/xterm@4.11.0/lib/xterm.js"></script>
+    <script src="https://unpkg.com/xterm-addon-fit@0.5.0/lib/xterm-addon-fit.js"></script>
+    <script src="https://unpkg.com/xterm-addon-web-links@0.4.0/lib/xterm-addon-web-links.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/socket.io/4.0.1/socket.io.min.js"></script>
+
+    <script>
+        const term = new Terminal({
+            cursorBlink: true,
+            macOptionIsMeta: true,
+            scrollback: 5000,
+            fontSize: 14,
+            fontFamily: 'Consolas, Monaco, monospace',
+            theme: {
+                background: '#1e1e1e',
+                foreground: '#d4d4d4',
+                cursor: '#d4d4d4',
+                cursorAccent: '#1e1e1e',
+                selectionBackground: 'rgba(255, 255, 255, 0.3)',
+            }
+        });
+
+        const fit = new FitAddon.FitAddon();
+        term.loadAddon(fit);
+        term.loadAddon(new WebLinksAddon.WebLinksAddon());
+
+        term.open(document.getElementById("terminal"));
+        fit.fit();
+
+        term.attachCustomKeyEventHandler((e) => {
+            if (e.type !== "keydown") return true;
+            if (e.ctrlKey && e.shiftKey) {
+                const key = e.key.toLowerCase();
+                if (key === "v") {
+                    navigator.clipboard.readText().then((text) => {
+                        term.writeText(text);
+                    });
+                    return false;
+                } else if (key === "c" || key === "x") {
+                    const selection = term.getSelection();
+                    if (selection) {
+                        navigator.clipboard.writeText(selection);
+                    }
+                    return false;
+                }
+            }
+            return true;
+        });
+
+        const socket = io.connect("/pty");
+        const status = document.getElementById("status");
+
+        term.onData((data) => {
+            socket.emit("pty-input", { input: data });
+        });
+
+        socket.on("pty-output", (data) => {
+            term.write(data.output);
+        });
+
+        socket.on("connect", () => {
+            status.innerHTML = '<span class="connected">connected</span>';
+            fitToScreen();
+        });
+
+        socket.on("disconnect", () => {
+            status.innerHTML = '<span class="disconnected">disconnected</span>';
+        });
+
+        socket.on("connect_error", (error) => {
+            status.innerHTML = '<span class="disconnected">error</span>';
+        });
+
+        function fitToScreen() {
+            fit.fit();
+            const dims = { cols: term.cols, rows: term.rows };
+            socket.emit("resize", dims);
+        }
+
+        function debounce(func, wait) {
+            let timeout;
+            return function(...args) {
+                clearTimeout(timeout);
+                timeout = setTimeout(() => func.apply(this, args), wait);
+            };
+        }
+
+        window.onresize = debounce(fitToScreen, 50);
+        setTimeout(fitToScreen, 100);
+    </script>
+</body>
+</html>
+"""
+
+    def start(self):
+        """Start the terminal server in a background thread."""
+        if self._running:
+            return self.get_url()
+
+        self._app, self._socketio = self._create_app()
+
+        def run_server():
+            self._socketio.run(
+                self._app,
+                host=self.host,
+                port=self.port,
+                debug=False,
+                use_reloader=False,
+                log_output=False,
+            )
+
+        self._thread = threading.Thread(target=run_server, daemon=True)
+        self._thread.start()
+        self._running = True
+
+        # Wait for server to start
+        time.sleep(1.0)
+
+        print(f"Terminal server started at http://{self.host}:{self.port}")
+        return self.get_url()
+
+    def get_url(self) -> str:
+        """Get the URL of the terminal server."""
+        return f"http://{self.host}:{self.port}"
+
+    def stop(self):
+        """Stop the terminal server."""
+        if self._app and self._app.config.get("child_pid"):
+            try:
+                os.kill(self._app.config["child_pid"], signal.SIGTERM)
+                time.sleep(0.1)
+                os.kill(self._app.config["child_pid"], signal.SIGKILL)
+            except (ProcessLookupError, OSError):
+                pass
+            self._app.config["child_pid"] = None
+            self._app.config["fd"] = None
+        self._running = False
+
+        if self.port in _terminal_servers:
+            del _terminal_servers[self.port]
+
+
+class Terminal:
+    """
+    A Terminal component that can be embedded in Gradio Blocks.
+
+    This component provides an interactive terminal using xterm.js
+    that communicates with a PTY backend through Flask-SocketIO.
+
+    IMPORTANT: If using SSH tunneling, tunnel both Gradio port and terminal port:
+        ssh -L 7860:localhost:7860 -L 5000:localhost:5000 user@remote
+
+    Example:
+        import gradio as gr
+        from gradio_terminal import Terminal
+
+        with gr.Blocks() as demo:
+            gr.Markdown("# My App with Terminal")
+            terminal = Terminal()
+
+        demo.launch()
+    """
+
+    def __init__(
+        self,
+        port: int = 5000,
+        host: str = "127.0.0.1",
+        command: str = "bash",
+        height: int = 400,
+        label: str | None = None,
+        visible: bool = True,
+        elem_id: str | None = None,
+        elem_classes: list[str] | str | None = None,
+    ):
+        """
+        Create a Terminal component.
+
+        Args:
+            port: Port for the terminal WebSocket server (must be tunneled if using SSH).
+            host: Host for the terminal server.
+            command: Shell command to run (default: bash).
+            height: Height of the terminal in pixels.
+            label: Label for the component.
+            visible: Whether the terminal is visible.
+            elem_id: HTML element ID.
+            elem_classes: CSS classes.
+        """
+        self.port = port
+        self.host = host
+        self.command = command
+        self.height = height
+        self.label = label
+        self.visible = visible
+        self.elem_id = elem_id
+        self.elem_classes = elem_classes
+
+        # Start the terminal server
+        self._server = TerminalServer(port=port, host=host, command=command)
+        terminal_url = self._server.start()
+
+        # Build the HTML with iframe
+        label_html = ""
+        if label:
+            label_html = (
+                f'<div style="font-weight: bold; margin-bottom: 5px; color: #d4d4d4;">{label}</div>'
+            )
+
+        # Use localhost for iframe src (browser connects to tunneled port)
+        iframe_url = f"http://localhost:{port}"
+
+        self._component = gr.HTML(
+            value=f"""
+            {label_html}
+            <div style="border: 1px solid #444; border-radius: 5px; overflow: hidden;">
+                <iframe
+                    src="{iframe_url}"
+                    style="border: none; width: 100%; height: {height}px;"
+                    allow="clipboard-read; clipboard-write"
+                ></iframe>
+            </div>
+            """,
+            visible=visible,
+            elem_id=elem_id,
+            elem_classes=elem_classes,
+        )
+
+    def stop(self):
+        """Stop the terminal server."""
+        self._server.stop()
+
+
+def create_terminal(
+    port: int = 5000,
+    host: str = "127.0.0.1",
+    command: str = "bash",
+    height: int = 400,
+    label: str | None = None,
+) -> Terminal:
+    """
+    Create a terminal component that can be used in Gradio Blocks.
+
+    Args:
+        port: Port for the terminal WebSocket server.
+        host: Host for the terminal server.
+        command: Shell command to run (default: bash).
+        height: Height of the terminal in pixels.
+        label: Optional label for the terminal.
+
+    Returns:
+        A Terminal instance.
+    """
+    return Terminal(
+        port=port,
+        host=host,
+        command=command,
+        height=height,
+        label=label,
+    )
+
+
+def create_terminal_demo(
+    port: int = 5000,
+    host: str = "127.0.0.1",
+    command: str = "bash",
+    height: int = 400,
+) -> gr.Blocks:
+    """
+    Create a Gradio Blocks demo with an embedded terminal.
+
+    Args:
+        port: Port for the terminal server.
+        host: Host for the terminal server.
+        command: Shell command to run.
+        height: Height of the terminal in pixels.
+
+    Returns:
+        A Gradio Blocks instance with the terminal.
+    """
+    with gr.Blocks(title="Gradio Terminal") as demo:
+        gr.Markdown("## Interactive Terminal")
+        gr.Markdown(f"Terminal server running on port {port}")
+
+        Terminal(port=port, host=host, command=command, height=height)
+
+        gr.Markdown(f"""
+            **Tips:**
+            - If using SSH tunneling, also tunnel port {port}:
+              `ssh -L 7860:localhost:7860 -L {port}:localhost:{port} user@remote`
+            """)
+
+    return demo
+
+
+def launch_terminal(
+    port: int = 5000,
+    host: str = "127.0.0.1",
+    command: str = "bash",
+    share: bool = False,
+    **launch_kwargs,
+):
+    """
+    Launch a standalone Gradio app with a terminal.
+
+    Args:
+        port: Port for the terminal WebSocket server.
+        host: Host for the terminal server.
+        command: Shell command to run (default: bash).
+        share: Whether to create a public link.
+        **launch_kwargs: Additional arguments passed to demo.launch()
+    """
+    demo = create_terminal_demo(port=port, host=host, command=command)
+    demo.launch(share=share, **launch_kwargs)

gradio_terminal-0.1.0/src/gradio_terminal.egg-info/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: gradio-terminal
+Version: 0.1.0
+Summary: A Gradio component that provides a fully functional terminal using xterm.js and PTY
+Author: Po-Hsuan Huang
+Author-email: Po-Hsuan Huang <aben20807@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/aben20807/gradio-terminal
+Project-URL: Repository, https://github.com/aben20807/gradio-terminal
+Project-URL: Issues, https://github.com/aben20807/gradio-terminal/issues
+Keywords: gradio,terminal,xterm,pty,shell
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gradio>=6.3.0
+Requires-Dist: flask>=3.1.2
+Requires-Dist: flask-socketio>=5.6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Dynamic: author
+Dynamic: license-file
+Dynamic: requires-python
+
+# Gradio Terminal
+
+A Gradio component that provides a fully functional terminal in your browser. This package uses xterm.js on the frontend and a PTY on the backend to provide a real shell experience.
+
+![Gradio Terminal](https://github.com/user-attachments/assets/8a4cc81a-07a4-4c56-a008-bd438eae50de)
+
+## Installation
+
+```bash
+pip install gradio-terminal
+```
+
+## Quick Start
+
+### Simple Usage
+
+```python
+import gradio as gr
+from gradio_terminal import Terminal
+demo = gr.Blocks()
+with demo:
+    terminal = Terminal()
+demo.launch()
+```
+
+## API Reference
+
+`launch_terminal(port=5000, host="127.0.0.1", command="bash", share=False, **launch_kwargs)`
+
+Launch a standalone Gradio app with a terminal.
+
+`create_terminal_demo(port=5000, host="127.0.0.1", command="bash", height=400)`
+
+Create a Gradio Blocks demo with an embedded terminal.
+
+`TerminalServer(port=5000, host="127.0.0.1", command="bash")`
+
+Low-level terminal server for custom integrations.
+
+- `start()`: Start the server and return the URL
+- `get_url()`: Get the terminal server URL
+- `stop()`: Stop the terminal server
+
+## Requirements
+
+- Python 3.8+
+- Linux
+- Dependencies: gradio, flask, flask-socketio
+
+## Security Notice
+
+This component provides shell access to your server. Use only in trusted environments.
+
+## License
+
+This project is licensed under the Apache-2.0 License.
+
+## Acknowledgments
+
+- [pyxtermjs](https://github.com/cs01/pyxtermjs) - Inspiration for the terminal implementation
+- [xterm.js](https://xtermjs.org/) - Terminal emulator for the browser
+- [Gradio](https://gradio.app/) - The awesome ML demo framework

gradio_terminal-0.1.0/src/gradio_terminal.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+src/gradio_terminal/__init__.py
+src/gradio_terminal/terminal.py
+src/gradio_terminal.egg-info/PKG-INFO
+src/gradio_terminal.egg-info/SOURCES.txt
+src/gradio_terminal.egg-info/dependency_links.txt
+src/gradio_terminal.egg-info/requires.txt
+src/gradio_terminal.egg-info/top_level.txt

gradio_terminal-0.1.0/src/gradio_terminal.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

gradio_terminal-0.1.0/src/gradio_terminal.egg-info/requires.txt

@@ -0,0 +1,8 @@
+gradio>=6.3.0
+flask>=3.1.2
+flask-socketio>=5.6.0
+
+[dev]
+pytest>=7.0.0
+black>=22.0.0
+flake8>=4.0.0

gradio_terminal-0.1.0/src/gradio_terminal.egg-info/top_level.txt

@@ -0,0 +1 @@
+gradio_terminal