ntermqt 0.1.1__tar.gz → 0.1.3__tar.gz

{ntermqt-0.1.1/ntermqt.egg-info → ntermqt-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ntermqt
-Version: 0.1.1
+Version: 0.1.3
 Summary: Modern SSH terminal widget for PyQt6 with credential vault and jump host support
 Author: Scott Peterman
 License: GPL-3.0
@@ -25,14 +25,23 @@ Requires-Dist: PyQt6-WebEngine>=6.4.0
 Requires-Dist: paramiko>=3.0.0
 Requires-Dist: cryptography>=41.0.0
 Requires-Dist: pyyaml>=6.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: pexpect>=4.8.0; sys_platform != "win32"
+Requires-Dist: pywinpty>=2.0.0; sys_platform == "win32"
 Provides-Extra: keyring
 Requires-Dist: keyring>=24.0.0; extra == "keyring"
+Provides-Extra: scripting
+Requires-Dist: ipython>=8.0.0; extra == "scripting"
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: pyinstaller; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: twine; extra == "dev"
+Requires-Dist: ipython>=8.0.0; extra == "dev"
+Provides-Extra: all
+Requires-Dist: keyring>=24.0.0; extra == "all"
+Requires-Dist: ipython>=8.0.0; extra == "all"
 
 # nterm
 
@@ -74,6 +83,12 @@ Built for managing hundreds of devices through bastion hosts with hardware secur
 - Cross-platform keychain: macOS Keychain, Windows Credential Locker, Linux Secret Service
 - Full PyQt6 management UI
 
+**Scripting API** *(Experimental)*
+- Query device inventory and credentials programmatically
+- Built-in IPython console with API pre-loaded
+- CLI for shell scripts and automation
+- Foundation for MCP tools and agentic workflows
+
 ---
 
 ## Screenshots
@@ -88,15 +103,48 @@ Built for managing hundreds of devices through bastion hosts with hardware secur
 
 ---
 
+## Dev Console
+
+nterm includes a built-in development console accessible via **Dev → IPython** or **Dev → Shell**. Open in a tab alongside your SSH sessions, or pop out to a separate window.
+
+![IPython Console](https://raw.githubusercontent.com/scottpeterman/nterm/main/screenshots/ipython.png)
+
+The IPython console runs in the same Python environment as nterm, with the scripting API pre-loaded. Query your device inventory, inspect credentials, and prototype automation workflows without leaving the app.
+
+```python
+# Available immediately when IPython opens
+api.devices()                    # List all saved devices
+api.search("leaf")               # Search by name/hostname  
+api.credentials()                # List credentials (after api.unlock())
+api.help()                       # Show all commands
+```
+
+**Use cases:**
+- Debug connection issues with live access to session objects
+- Prototype automation scripts against your real device inventory
+- Test credential resolution patterns
+- Build and test MCP tools interactively
+
+Requires the `scripting` extra: `pip install ntermqt[scripting]`
+
+---
+
 ## Installation
 
+### Be aware due to a naming conflict, the pypi package is actually "ntermqt"
+
 ### From PyPI
 
+https://pypi.org/project/ntermqt/
+
 ```bash
-pip install nterm
+pip install ntermqt
 
-# Optional: system keychain support
-pip install nterm[keyring]
+# With optional scripting support (IPython)
+pip install ntermqt[scripting]
+
+# With all optional features
+pip install ntermqt[all]
 
 # Run
 nterm
@@ -114,10 +162,7 @@ source .venv/bin/activate  # Linux/macOS
 # .venv\Scripts\activate   # Windows
 
 # Install in development mode
-pip install -e .
-
-# Optional: system keychain support
-pip install keyring
+pip install -e ".[all]"
 
 # Run
 nterm
@@ -137,12 +182,70 @@ python -m nterm
 
 | Platform | PTY | Keychain |
 |----------|-----|----------|
-| Linux | ✅ Native | Secret Service |
-| macOS | ✅ Native | macOS Keychain |
+| Linux | ✅ pexpect | Secret Service |
+| macOS | ✅ pexpect | macOS Keychain |
 | Windows 10+ | ✅ pywinpty | Credential Locker |
 
 ---
 
+## Scripting API *(Experimental)*
+
+nterm includes a scripting API for programmatic access to your device inventory and credential vault. Use it from IPython, CLI, or Python scripts.
+
+### IPython Console
+
+Open **Dev → IPython → Open in Tab** to get an interactive console with the API pre-loaded:
+
+```python
+api.devices()                    # List all saved devices
+api.search("leaf")               # Search by name/hostname
+api.devices("eng-*")             # Glob pattern filter
+
+api.unlock("vault-password")     # Unlock credential vault
+api.credentials()                # List credentials (metadata only)
+
+api.help()                       # Show all commands
+```
+
+### CLI
+
+```bash
+nterm-cli devices                     # List all devices
+nterm-cli search leaf                 # Search devices
+nterm-cli device eng-leaf-1           # Device details
+nterm-cli credentials --unlock        # List credentials
+nterm-cli --json devices              # JSON output for scripting
+```
+
+### Python Scripts
+
+```python
+from nterm.scripting import NTermAPI
+
+api = NTermAPI()
+
+# Query devices
+for device in api.devices("*spine*"):
+    print(f"{device.name}: {device.hostname}")
+
+# Work with credentials
+api.unlock("vault-password")
+cred = api.credential("lab-admin")
+print(f"Username: {cred.username}")
+```
+
+### Roadmap
+
+The scripting API is the foundation for:
+
+- **Command execution** — `api.connect()` and `api.send()` for programmatic device interaction
+- **Batch operations** — Fan out commands across device groups
+- **MCP tool integration** — Expose nterm capabilities to AI agents
+
+See [scripting/README.md](nterm/scripting/README.md) for full API documentation.
+
+---
+
 ## Quick Start
 
 ### As a Widget
@@ -289,6 +392,7 @@ nterm/
 ├── session/
 │   ├── ssh.py         # SSHSession (Paramiko) with legacy fallback
 │   ├── interactive_ssh.py   # Native SSH + PTY
+│   ├── local_terminal.py    # Local shell/IPython sessions
 │   └── pty_transport.py     # Cross-platform PTY
 ├── terminal/
 │   ├── widget.py      # TerminalWidget (PyQt6 + xterm.js)
@@ -300,7 +404,10 @@ nterm/
 │   ├── store.py       # Encrypted credential storage
 │   ├── resolver.py    # Pattern-based resolution
 │   └── manager_ui.py  # PyQt6 credential manager
-└── manager/           # Session tree, connection dialogs
+├── manager/           # Session tree, connection dialogs
+└── scripting/         # API, CLI, automation support
+    ├── api.py         # NTermAPI class
+    └── cli.py         # nterm-cli entry point
 ```
 
 ---

{ntermqt-0.1.1 → ntermqt-0.1.3}/README.md

@@ -38,6 +38,12 @@ Built for managing hundreds of devices through bastion hosts with hardware secur
 - Cross-platform keychain: macOS Keychain, Windows Credential Locker, Linux Secret Service
 - Full PyQt6 management UI
 
+**Scripting API** *(Experimental)*
+- Query device inventory and credentials programmatically
+- Built-in IPython console with API pre-loaded
+- CLI for shell scripts and automation
+- Foundation for MCP tools and agentic workflows
+
 ---
 
 ## Screenshots
@@ -52,15 +58,48 @@ Built for managing hundreds of devices through bastion hosts with hardware secur
 
 ---
 
+## Dev Console
+
+nterm includes a built-in development console accessible via **Dev → IPython** or **Dev → Shell**. Open in a tab alongside your SSH sessions, or pop out to a separate window.
+
+![IPython Console](https://raw.githubusercontent.com/scottpeterman/nterm/main/screenshots/ipython.png)
+
+The IPython console runs in the same Python environment as nterm, with the scripting API pre-loaded. Query your device inventory, inspect credentials, and prototype automation workflows without leaving the app.
+
+```python
+# Available immediately when IPython opens
+api.devices()                    # List all saved devices
+api.search("leaf")               # Search by name/hostname  
+api.credentials()                # List credentials (after api.unlock())
+api.help()                       # Show all commands
+```
+
+**Use cases:**
+- Debug connection issues with live access to session objects
+- Prototype automation scripts against your real device inventory
+- Test credential resolution patterns
+- Build and test MCP tools interactively
+
+Requires the `scripting` extra: `pip install ntermqt[scripting]`
+
+---
+
 ## Installation
 
+### Be aware due to a naming conflict, the pypi package is actually "ntermqt"
+
 ### From PyPI
 
+https://pypi.org/project/ntermqt/
+
 ```bash
-pip install nterm
+pip install ntermqt
 
-# Optional: system keychain support
-pip install nterm[keyring]
+# With optional scripting support (IPython)
+pip install ntermqt[scripting]
+
+# With all optional features
+pip install ntermqt[all]
 
 # Run
 nterm
@@ -78,10 +117,7 @@ source .venv/bin/activate  # Linux/macOS
 # .venv\Scripts\activate   # Windows
 
 # Install in development mode
-pip install -e .
-
-# Optional: system keychain support
-pip install keyring
+pip install -e ".[all]"
 
 # Run
 nterm
@@ -101,12 +137,70 @@ python -m nterm
 
 | Platform | PTY | Keychain |
 |----------|-----|----------|
-| Linux | ✅ Native | Secret Service |
-| macOS | ✅ Native | macOS Keychain |
+| Linux | ✅ pexpect | Secret Service |
+| macOS | ✅ pexpect | macOS Keychain |
 | Windows 10+ | ✅ pywinpty | Credential Locker |
 
 ---
 
+## Scripting API *(Experimental)*
+
+nterm includes a scripting API for programmatic access to your device inventory and credential vault. Use it from IPython, CLI, or Python scripts.
+
+### IPython Console
+
+Open **Dev → IPython → Open in Tab** to get an interactive console with the API pre-loaded:
+
+```python
+api.devices()                    # List all saved devices
+api.search("leaf")               # Search by name/hostname
+api.devices("eng-*")             # Glob pattern filter
+
+api.unlock("vault-password")     # Unlock credential vault
+api.credentials()                # List credentials (metadata only)
+
+api.help()                       # Show all commands
+```
+
+### CLI
+
+```bash
+nterm-cli devices                     # List all devices
+nterm-cli search leaf                 # Search devices
+nterm-cli device eng-leaf-1           # Device details
+nterm-cli credentials --unlock        # List credentials
+nterm-cli --json devices              # JSON output for scripting
+```
+
+### Python Scripts
+
+```python
+from nterm.scripting import NTermAPI
+
+api = NTermAPI()
+
+# Query devices
+for device in api.devices("*spine*"):
+    print(f"{device.name}: {device.hostname}")
+
+# Work with credentials
+api.unlock("vault-password")
+cred = api.credential("lab-admin")
+print(f"Username: {cred.username}")
+```
+
+### Roadmap
+
+The scripting API is the foundation for:
+
+- **Command execution** — `api.connect()` and `api.send()` for programmatic device interaction
+- **Batch operations** — Fan out commands across device groups
+- **MCP tool integration** — Expose nterm capabilities to AI agents
+
+See [scripting/README.md](nterm/scripting/README.md) for full API documentation.
+
+---
+
 ## Quick Start
 
 ### As a Widget
@@ -253,6 +347,7 @@ nterm/
 ├── session/
 │   ├── ssh.py         # SSHSession (Paramiko) with legacy fallback
 │   ├── interactive_ssh.py   # Native SSH + PTY
+│   ├── local_terminal.py    # Local shell/IPython sessions
 │   └── pty_transport.py     # Cross-platform PTY
 ├── terminal/
 │   ├── widget.py      # TerminalWidget (PyQt6 + xterm.js)
@@ -264,7 +359,10 @@ nterm/
 │   ├── store.py       # Encrypted credential storage
 │   ├── resolver.py    # Pattern-based resolution
 │   └── manager_ui.py  # PyQt6 credential manager
-└── manager/           # Session tree, connection dialogs
+├── manager/           # Session tree, connection dialogs
+└── scripting/         # API, CLI, automation support
+    ├── api.py         # NTermAPI class
+    └── cli.py         # nterm-cli entry point
 ```
 
 ---

{ntermqt-0.1.1 → ntermqt-0.1.3}/nterm/__main__.py

@@ -22,6 +22,7 @@ from nterm.manager import (
 )
 from nterm.terminal.widget import TerminalWidget
 from nterm.session.ssh import SSHSession
+from nterm.session.local_terminal import LocalTerminal
 from nterm.connection.profile import ConnectionProfile, AuthConfig
 from nterm.vault import CredentialManagerWidget
 from nterm.vault.resolver import CredentialResolver
@@ -225,6 +226,35 @@ class TerminalTab(QWidget):
         return True
 
 
+class LocalTerminalTab(QWidget):
+    """A terminal tab for local processes (shell, IPython, etc.)."""
+
+    def __init__(self, name: str, session: LocalTerminal, parent=None):
+        super().__init__(parent)
+        self.name = name
+        self.local_session = session
+
+        layout = QVBoxLayout(self)
+        layout.setContentsMargins(0, 0, 0, 0)
+
+        self.terminal = TerminalWidget()
+        layout.addWidget(self.terminal)
+
+        self.terminal.attach_session(self.local_session)
+
+    def connect(self):
+        """Start the local process."""
+        self.local_session.connect()
+
+    def disconnect(self):
+        """Terminate the local process."""
+        self.local_session.disconnect()
+
+    def is_connected(self) -> bool:
+        """Check if the process is still running."""
+        return self.local_session.is_connected
+
+
 class MainWindow(QMainWindow):
     """
     Main application window with session tree and tabbed terminals.
@@ -274,7 +304,7 @@ class MainWindow(QMainWindow):
         # Apply multiline threshold to all open terminals
         for i in range(self.tab_widget.count()):
             tab = self.tab_widget.widget(i)
-            if isinstance(tab, TerminalTab):
+            if isinstance(tab, (TerminalTab, LocalTerminalTab)):
                 tab.terminal.set_multiline_threshold(settings.multiline_paste_threshold)
 
 
@@ -401,6 +431,32 @@ class MainWindow(QMainWindow):
             action.triggered.connect(lambda checked, n=theme_name: self._apply_theme_by_name(n))
             theme_menu.addAction(action)
 
+        # Dev menu
+        dev_menu = menubar.addMenu("&Dev")
+
+        # IPython submenu
+        ipython_menu = dev_menu.addMenu("&IPython")
+
+        ipython_tab_action = QAction("Open in &Tab", self)
+        ipython_tab_action.setShortcut(QKeySequence("Ctrl+Shift+I"))
+        ipython_tab_action.triggered.connect(lambda: self._open_local("IPython", LocalTerminal.ipython(), "tab"))
+        ipython_menu.addAction(ipython_tab_action)
+
+        ipython_window_action = QAction("Open in &Window", self)
+        ipython_window_action.triggered.connect(lambda: self._open_local("IPython", LocalTerminal.ipython(), "window"))
+        ipython_menu.addAction(ipython_window_action)
+
+        # Shell submenu
+        shell_menu = dev_menu.addMenu("&Shell")
+
+        shell_tab_action = QAction("Open in &Tab", self)
+        shell_tab_action.triggered.connect(lambda: self._open_local("Shell", LocalTerminal(), "tab"))
+        shell_menu.addAction(shell_tab_action)
+
+        shell_window_action = QAction("Open in &Window", self)
+        shell_window_action.triggered.connect(lambda: self._open_local("Shell", LocalTerminal(), "window"))
+        shell_menu.addAction(shell_window_action)
+
     def _on_import_sessions(self):
         """Show import dialog."""
         dialog = ImportDialog(self.session_store, self)
@@ -445,7 +501,7 @@ class MainWindow(QMainWindow):
         # Update all open terminal tabs
         for i in range(self.tab_widget.count()):
             tab = self.tab_widget.widget(i)
-            if isinstance(tab, TerminalTab):
+            if isinstance(tab, (TerminalTab, LocalTerminalTab)):
                 tab.terminal.set_theme(theme)
 
     def _apply_qt_theme(self, theme: Theme):
@@ -560,6 +616,23 @@ class MainWindow(QMainWindow):
         self._child_windows.append(window)
         window.destroyed.connect(lambda: self._child_windows.remove(window))
 
+    def _open_local(self, name: str, session: LocalTerminal, mode: str):
+        """Open a local terminal session (IPython, shell, etc.)."""
+        if mode == "tab":
+            tab = LocalTerminalTab(name, session)
+            tab.terminal.set_theme(self.current_theme)
+            idx = self.tab_widget.addTab(tab, name)
+            self.tab_widget.setCurrentIndex(idx)
+            self.tab_widget.setTabToolTip(idx, f"{name} (local)")
+            tab.connect()
+        else:
+            window = LocalTerminalWindow(name, session, self.current_theme)
+            window.show()
+            if not hasattr(self, '_child_windows'):
+                self._child_windows = []
+            self._child_windows.append(window)
+            window.destroyed.connect(lambda: self._child_windows.remove(window))
+
     # -------------------------------------------------------------------------
     # Tab Management (NEW)
     # -------------------------------------------------------------------------
@@ -569,7 +642,7 @@ class MainWindow(QMainWindow):
         count = 0
         for i in range(self.tab_widget.count()):
             tab = self.tab_widget.widget(i)
-            if isinstance(tab, TerminalTab) and tab.is_connected():
+            if isinstance(tab, (TerminalTab, LocalTerminalTab)) and tab.is_connected():
                 count += 1
         return count
 
@@ -619,13 +692,29 @@ class MainWindow(QMainWindow):
 
             tab.disconnect()
 
+        elif isinstance(tab, LocalTerminalTab):
+            # Check if process is still running
+            if tab.is_connected():
+                reply = QMessageBox.question(
+                    self,
+                    "Close Tab",
+                    f"'{tab.name}' is still running.\n\n"
+                    "Terminate and close this tab?",
+                    QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No,
+                    QMessageBox.StandardButton.No
+                )
+                if reply != QMessageBox.StandardButton.Yes:
+                    return
+
+            tab.disconnect()
+
         self.tab_widget.removeTab(index)
 
     def _close_other_tabs(self, keep_index: int):
         """Close all tabs except the specified one."""
         active_count = self._get_active_session_count()
         tab_to_keep = self.tab_widget.widget(keep_index)
-        keep_is_active = isinstance(tab_to_keep, TerminalTab) and tab_to_keep.is_connected()
+        keep_is_active = isinstance(tab_to_keep, (TerminalTab, LocalTerminalTab)) and tab_to_keep.is_connected()
         other_active = active_count - (1 if keep_is_active else 0)
 
         if other_active > 0:
@@ -644,7 +733,7 @@ class MainWindow(QMainWindow):
         for i in range(self.tab_widget.count() - 1, -1, -1):
             if i != keep_index:
                 tab = self.tab_widget.widget(i)
-                if isinstance(tab, TerminalTab):
+                if isinstance(tab, (TerminalTab, LocalTerminalTab)):
                     tab.disconnect()
                 self.tab_widget.removeTab(i)
 
@@ -658,7 +747,7 @@ class MainWindow(QMainWindow):
         active_count = 0
         for i in range(index + 1, self.tab_widget.count()):
             tab = self.tab_widget.widget(i)
-            if isinstance(tab, TerminalTab) and tab.is_connected():
+            if isinstance(tab, (TerminalTab, LocalTerminalTab)) and tab.is_connected():
                 active_count += 1
 
         if active_count > 0:
@@ -676,7 +765,7 @@ class MainWindow(QMainWindow):
         # Close from end to avoid index shifting
         for i in range(self.tab_widget.count() - 1, index, -1):
             tab = self.tab_widget.widget(i)
-            if isinstance(tab, TerminalTab):
+            if isinstance(tab, (TerminalTab, LocalTerminalTab)):
                 tab.disconnect()
             self.tab_widget.removeTab(i)
 
@@ -702,7 +791,7 @@ class MainWindow(QMainWindow):
         # Close all tabs
         while self.tab_widget.count() > 0:
             tab = self.tab_widget.widget(0)
-            if isinstance(tab, TerminalTab):
+            if isinstance(tab, (TerminalTab, LocalTerminalTab)):
                 tab.disconnect()
             self.tab_widget.removeTab(0)
 
@@ -741,7 +830,7 @@ class MainWindow(QMainWindow):
         # Disconnect all tabs
         for i in range(self.tab_widget.count()):
             tab = self.tab_widget.widget(i)
-            if isinstance(tab, TerminalTab):
+            if isinstance(tab, (TerminalTab, LocalTerminalTab)):
                 tab.disconnect()
 
         self.session_store.close()
@@ -790,6 +879,40 @@ class TerminalWindow(QMainWindow):
         event.accept()
 
 
+class LocalTerminalWindow(QMainWindow):
+    """Standalone window for local terminal sessions."""
+
+    def __init__(self, name: str, session: LocalTerminal, theme: Theme):
+        super().__init__()
+        self.setWindowTitle(f"{name} - Local")
+        self.resize(1000, 700)
+
+        self.setStyleSheet(generate_stylesheet(theme))
+
+        self.tab = LocalTerminalTab(name, session)
+        self.tab.terminal.set_theme(theme)
+        self.setCentralWidget(self.tab)
+
+        self.tab.connect()
+
+    def closeEvent(self, event):
+        """Terminate on close with confirmation."""
+        if self.tab.is_connected():
+            reply = QMessageBox.question(
+                self,
+                "Close Window",
+                f"'{self.tab.name}' is still running.\n\nTerminate and close?",
+                QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No,
+                QMessageBox.StandardButton.No
+            )
+            if reply != QMessageBox.StandardButton.Yes:
+                event.ignore()
+                return
+
+        self.tab.disconnect()
+        event.accept()
+
+
 def main():
     app = QApplication(sys.argv)
 

ntermqt-0.1.3/nterm/scripting/__init__.py

@@ -0,0 +1,43 @@
+"""
+nterm.scripting - Scripting API for nterm
+
+Provides programmatic access to nterm's device sessions and credential vault.
+Usable from IPython, CLI, scripts, or as foundation for MCP tools.
+
+Quick Start (IPython):
+    from nterm.scripting import api
+
+    api.devices()                  # List all saved devices
+    api.search("leaf")             # Search devices
+    api.device("eng-leaf-1")       # Get specific device
+
+    api.unlock("vault-password")   # Unlock credential vault
+    api.credentials()              # List credentials
+
+    api.help()                     # Show all commands
+
+Quick Start (CLI):
+    nterm-cli devices
+    nterm-cli search leaf
+    nterm-cli credentials --unlock
+"""
+
+from .api import (
+    NTermAPI,
+    DeviceInfo,
+    CredentialInfo,
+    get_api,
+    reset_api,
+)
+
+# Convenience: pre-instantiated API
+api = get_api()
+
+__all__ = [
+    "NTermAPI",
+    "DeviceInfo",
+    "CredentialInfo",
+    "get_api",
+    "reset_api",
+    "api",
+]