ntermqt 0.1.1__tar.gz → 0.1.5__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ntermqt
-Version: 0.1.1
+Version: 0.1.5
 Summary: Modern SSH terminal widget for PyQt6 with credential vault and jump host support
 Author: Scott Peterman
 License: GPL-3.0
@@ -25,6 +25,12 @@ 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: ipython>=8.0.0
+Requires-Dist: requests>=2.10.0
+Requires-Dist: textfsm>=2.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: dev
@@ -33,6 +39,8 @@ Requires-Dist: black; extra == "dev"
 Requires-Dist: pyinstaller; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: twine; extra == "dev"
+Provides-Extra: all
+Requires-Dist: keyring>=24.0.0; extra == "all"
 
 # nterm
 
@@ -50,9 +58,11 @@ Built for managing hundreds of devices through bastion hosts with hardware secur
 
 **Terminal**
 - xterm.js rendering via QWebEngineView — full VT100/ANSI support
-- Built-in themes: Catppuccin, Dracula, Nord, Solarized, Gruvbox (dark/light/hybrid)
+- 12 built-in themes: Catppuccin, Dracula, Nord, Solarized, Gruvbox, Enterprise variants
+- Hybrid themes: dark UI chrome with light terminal for readability
 - Custom YAML themes with independent terminal and UI colors
 - Tab or window per session — pop sessions to separate windows
+- Session capture to file (clean text, ANSI stripped)
 - Unicode, emoji, box-drawing characters
 
 **Authentication**
@@ -74,6 +84,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 +104,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
+
+# With optional scripting support (IPython)
+pip install ntermqt[scripting]
 
-# Optional: system keychain support
-pip install nterm[keyring]
+# With all optional features
+pip install ntermqt[all]
 
 # Run
 nterm
@@ -114,10 +163,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 +183,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
@@ -203,19 +307,33 @@ session.connect()
 
 ## Themes
 
-### Built-in
+nterm includes 12 built-in themes covering dark, light, and hybrid styles.
+
+### Built-in Themes
 
 ```python
-Theme.default()         # Catppuccin Mocha
-Theme.dracula()         # Dracula
-Theme.nord()            # Nord
-Theme.solarized_dark()  # Solarized Dark
-Theme.gruvbox_dark()    # Gruvbox Dark
-Theme.gruvbox_light()   # Gruvbox Light
-Theme.gruvbox_hybrid()  # Dark UI + Light terminal
+# Dark themes
+Theme.default()           # Catppuccin Mocha
+Theme.dracula()           # Dracula
+Theme.nord()              # Nord
+Theme.solarized_dark()    # Solarized Dark
+Theme.gruvbox_dark()      # Gruvbox Dark
+Theme.enterprise_dark()   # Microsoft-inspired dark
+
+# Light themes
+Theme.gruvbox_light()     # Gruvbox Light
+Theme.enterprise_light()  # Microsoft-inspired light
+Theme.clean()             # Warm paper tones
+
+# Hybrid themes (dark UI + light terminal)
+Theme.gruvbox_hybrid()    # Gruvbox dark chrome, light terminal
+Theme.nord_hybrid()       # Nord polar night chrome, snow storm terminal
+Theme.enterprise_hybrid() # VS Code-style dark/light split
 ```
 
-### Custom YAML
+**Hybrid themes** combine a dark application chrome (menus, tabs, sidebars) with a light terminal for maximum readability — ideal for long sessions reviewing configs or logs.
+
+### Custom YAML Themes
 
 ```yaml
 # ~/.nterm/themes/my-theme.yaml
@@ -244,6 +362,19 @@ accent_color: "#7aa2f7"
 
 ---
 
+## Session Capture
+
+Capture session output to a file for documentation, auditing, or extracting config snippets.
+
+**Right-click in terminal → Start Capture...** to begin recording. Output is saved as clean text with ANSI escape sequences stripped — ready for grep, diff, or pasting into tickets.
+
+- Per-session capture (each tab independent)
+- File dialog for save location
+- Menu shows active capture filename
+- Auto-stops when session closes
+
+---
+
 ## Jump Hosts
 
 ```python
@@ -289,6 +420,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 +432,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.5}/README.md

@@ -14,9 +14,11 @@ Built for managing hundreds of devices through bastion hosts with hardware secur
 
 **Terminal**
 - xterm.js rendering via QWebEngineView — full VT100/ANSI support
-- Built-in themes: Catppuccin, Dracula, Nord, Solarized, Gruvbox (dark/light/hybrid)
+- 12 built-in themes: Catppuccin, Dracula, Nord, Solarized, Gruvbox, Enterprise variants
+- Hybrid themes: dark UI chrome with light terminal for readability
 - Custom YAML themes with independent terminal and UI colors
 - Tab or window per session — pop sessions to separate windows
+- Session capture to file (clean text, ANSI stripped)
 - Unicode, emoji, box-drawing characters
 
 **Authentication**
@@ -38,6 +40,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 +60,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
+
+# With optional scripting support (IPython)
+pip install ntermqt[scripting]
 
-# Optional: system keychain support
-pip install nterm[keyring]
+# With all optional features
+pip install ntermqt[all]
 
 # Run
 nterm
@@ -78,10 +119,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 +139,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
@@ -167,19 +263,33 @@ session.connect()
 
 ## Themes
 
-### Built-in
+nterm includes 12 built-in themes covering dark, light, and hybrid styles.
+
+### Built-in Themes
 
 ```python
-Theme.default()         # Catppuccin Mocha
-Theme.dracula()         # Dracula
-Theme.nord()            # Nord
-Theme.solarized_dark()  # Solarized Dark
-Theme.gruvbox_dark()    # Gruvbox Dark
-Theme.gruvbox_light()   # Gruvbox Light
-Theme.gruvbox_hybrid()  # Dark UI + Light terminal
+# Dark themes
+Theme.default()           # Catppuccin Mocha
+Theme.dracula()           # Dracula
+Theme.nord()              # Nord
+Theme.solarized_dark()    # Solarized Dark
+Theme.gruvbox_dark()      # Gruvbox Dark
+Theme.enterprise_dark()   # Microsoft-inspired dark
+
+# Light themes
+Theme.gruvbox_light()     # Gruvbox Light
+Theme.enterprise_light()  # Microsoft-inspired light
+Theme.clean()             # Warm paper tones
+
+# Hybrid themes (dark UI + light terminal)
+Theme.gruvbox_hybrid()    # Gruvbox dark chrome, light terminal
+Theme.nord_hybrid()       # Nord polar night chrome, snow storm terminal
+Theme.enterprise_hybrid() # VS Code-style dark/light split
 ```
 
-### Custom YAML
+**Hybrid themes** combine a dark application chrome (menus, tabs, sidebars) with a light terminal for maximum readability — ideal for long sessions reviewing configs or logs.
+
+### Custom YAML Themes
 
 ```yaml
 # ~/.nterm/themes/my-theme.yaml
@@ -208,6 +318,19 @@ accent_color: "#7aa2f7"
 
 ---
 
+## Session Capture
+
+Capture session output to a file for documentation, auditing, or extracting config snippets.
+
+**Right-click in terminal → Start Capture...** to begin recording. Output is saved as clean text with ANSI escape sequences stripped — ready for grep, diff, or pasting into tickets.
+
+- Per-session capture (each tab independent)
+- File dialog for save location
+- Menu shows active capture filename
+- Auto-stops when session closes
+
+---
+
 ## Jump Hosts
 
 ```python
@@ -253,6 +376,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 +388,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
 ```
 
 ---