ntermqt 0.1.7__py3-none-any.whl → 0.1.9__py3-none-any.whl

nterm/scripting/test_api_repl.py

@@ -0,0 +1,290 @@
+#!/usr/bin/env python3
+"""
+Test script to verify new API backend works with REPL.
+
+Run from nterm project directory:
+    python -m nterm.scripting.test_api_repl
+
+Or in IPython:
+    %run nterm/scripting/test_api_repl.py
+"""
+
+import sys
+from pathlib import Path
+
+
+def test_api_imports():
+    """Test that all new API components import correctly."""
+    print("=" * 60)
+    print("Testing API Imports")
+    print("=" * 60)
+
+    try:
+        from nterm.scripting.api import NTermAPI, get_api
+        print("✓ NTermAPI imported")
+    except ImportError as e:
+        print(f"✗ NTermAPI import failed: {e}")
+        return False
+
+    try:
+        from nterm.scripting.models import ActiveSession, CommandResult, DeviceInfo, CredentialInfo
+        print("✓ Models imported")
+    except ImportError as e:
+        print(f"✗ Models import failed: {e}")
+        return False
+
+    try:
+        from nterm.scripting.platform_data import PLATFORM_COMMANDS, PLATFORM_PATTERNS
+        print("✓ Platform data imported")
+        print(f"  - {len(PLATFORM_PATTERNS)} platforms defined")
+        print(f"  - {len(list(PLATFORM_COMMANDS.get('cisco_ios', {}).keys()))} command types for cisco_ios")
+    except ImportError as e:
+        print(f"✗ Platform data import failed: {e}")
+        return False
+
+    try:
+        from nterm.scripting.platform_utils import (
+            detect_platform,
+            get_platform_command,
+            extract_version_info,
+            extract_field,
+        )
+        print("✓ Platform utils imported")
+    except ImportError as e:
+        print(f"✗ Platform utils import failed: {e}")
+        return False
+
+    try:
+        from nterm.scripting.ssh_connection import (
+            connect_ssh,
+            send_command,
+            wait_for_prompt,
+            filter_ansi_sequences,
+            PagingNotDisabledError,
+        )
+        print("✓ SSH connection imported")
+    except ImportError as e:
+        print(f"✗ SSH connection import failed: {e}")
+        return False
+
+    print()
+    return True
+
+
+def test_platform_utils():
+    """Test platform utility functions."""
+    print("=" * 60)
+    print("Testing Platform Utils")
+    print("=" * 60)
+
+    from nterm.scripting.platform_utils import (
+        detect_platform,
+        get_platform_command,
+        extract_field,
+        extract_version_info,
+    )
+
+    # Test detect_platform
+    test_cases = [
+        ("Cisco IOS Software, IOSv Software", "cisco_ios"),
+        ("Arista vEOS", "arista_eos"),
+        ("Cisco Nexus Operating System", "cisco_nxos"),
+        ("JUNOS 20.4R1", "juniper_junos"),
+        ("Unknown device", None),
+    ]
+
+    print("\ndetect_platform():")
+    for version_output, expected in test_cases:
+        result = detect_platform(version_output)
+        status = "✓" if result == expected else "✗"
+        print(f"  {status} '{version_output[:30]}...' -> {result} (expected: {expected})")
+
+    # Test get_platform_command
+    print("\nget_platform_command():")
+
+    cmd = get_platform_command('cisco_ios', 'config')
+    print(f"  cisco_ios + config -> '{cmd}'")
+
+    cmd = get_platform_command('juniper_junos', 'config')
+    print(f"  juniper_junos + config -> '{cmd}'")
+
+    cmd = get_platform_command('cisco_ios', 'interface_detail', name='Gi0/1')
+    print(f"  cisco_ios + interface_detail(name='Gi0/1') -> '{cmd}'")
+
+    cmd = get_platform_command('arista_eos', 'neighbors')
+    print(f"  arista_eos + neighbors -> '{cmd}'")
+
+    # Test extract_field
+    print("\nextract_field():")
+    test_data = {'VERSION': '15.2(4)M', 'HARDWARE': ['ISR4451', 'ISR4451-X']}
+
+    result = extract_field(test_data, ['version', 'VERSION', 'SOFTWARE'])
+    print(f"  Extract version from {test_data}: '{result}'")
+
+    result = extract_field(test_data, ['HARDWARE', 'MODEL'], first_element=True)
+    print(f"  Extract hardware (first): '{result}'")
+
+    result = extract_field(test_data, ['HARDWARE', 'MODEL'], first_element=False)
+    print(f"  Extract hardware (list): '{result}'")
+
+    # Test extract_version_info
+    print("\nextract_version_info():")
+    parsed_data = [{'VERSION': '15.2', 'HARDWARE': 'C3850', 'SERIAL': 'FCW1234'}]
+    info = extract_version_info(parsed_data, 'cisco_ios')
+    print(f"  Extracted: {info}")
+
+    print()
+    return True
+
+
+def test_ansi_filtering():
+    """Test ANSI sequence filtering."""
+    print("=" * 60)
+    print("Testing ANSI Filtering")
+    print("=" * 60)
+
+    from nterm.scripting.ssh_connection import filter_ansi_sequences
+
+    test_cases = [
+        # (input, expected_output_contains)
+        ("\x1b[24;1Hdevice#", "device#"),
+        ("\x1b[0m\x1b[2Kshow version\x1b[0m", "show version"),
+        ("\x1b[?25hrouter>", "router>"),
+        ("clean text", "clean text"),
+        ("\x07bell\x07", "bell"),
+    ]
+
+    for raw, expected_contains in test_cases:
+        filtered = filter_ansi_sequences(raw)
+        status = "✓" if expected_contains in filtered else "✗"
+        print(f"  {status} Input: {repr(raw)[:40]}")
+        print(f"      Output: '{filtered}'")
+
+    print()
+    return True
+
+
+def test_api_initialization():
+    """Test API can be initialized."""
+    print("=" * 60)
+    print("Testing API Initialization")
+    print("=" * 60)
+
+    try:
+        from nterm.scripting.api import NTermAPI
+
+        # This will fail if tfsm_templates.db doesn't exist
+        # That's expected in some environments
+        api = NTermAPI()
+        print(f"✓ API initialized: {api}")
+
+        # Test status
+        status = api.status()
+        print(f"  Devices: {status['devices']}")
+        print(f"  Folders: {status['folders']}")
+        print(f"  Vault: {'unlocked' if status['vault_unlocked'] else 'locked'}")
+        print(f"  Parser DB: {status['parser_db']}")
+
+        # Test new methods exist
+        print("\nNew API methods:")
+        print(f"  ✓ session() context manager: {hasattr(api, 'session')}")
+        print(f"  ✓ send_first(): {hasattr(api, 'send_first')}")
+        print(f"  ✓ send_platform_command(): {hasattr(api, 'send_platform_command')}")
+        print(f"  ✓ disconnect_all(): {hasattr(api, 'disconnect_all')}")
+
+        # Test active_sessions returns correct type
+        sessions = api.active_sessions()
+        print(f"  ✓ active_sessions() returns list: {isinstance(sessions, list)}")
+
+        print()
+        return True
+
+    except Exception as e:
+        print(f"✗ API initialization failed: {e}")
+        print("  (This is expected if tfsm_templates.db is not present)")
+        print()
+        return False
+
+
+def test_repl_imports():
+    """Test REPL imports."""
+    print("=" * 60)
+    print("Testing REPL Imports")
+    print("=" * 60)
+
+    try:
+        from nterm.scripting.repl import NTermREPL, REPLPolicy, REPLState
+        print("✓ REPL classes imported")
+    except ImportError as e:
+        print(f"✗ REPL import failed: {e}")
+        return False
+
+    try:
+        from nterm.scripting.repl_interactive import start_repl
+        print("✓ Interactive REPL imported")
+    except ImportError as e:
+        print(f"✗ Interactive REPL import failed: {e}")
+        return False
+
+    # Test policy
+    policy = REPLPolicy(mode="read_only")
+    print(f"\nPolicy tests (mode={policy.mode}):")
+
+    test_commands = [
+        ("show version", True),
+        ("show interfaces", True),
+        ("configure terminal", False),
+        ("write memory", False),
+        ("reload", False),
+        ("copy running-config startup-config", False),
+    ]
+
+    for cmd, expected in test_commands:
+        allowed = policy.is_allowed(cmd)
+        status = "✓" if allowed == expected else "✗"
+        print(
+            f"  {status} '{cmd}' -> {'allowed' if allowed else 'blocked'} (expected: {'allowed' if expected else 'blocked'})")
+
+    print()
+    return True
+
+
+def run_all_tests():
+    """Run all tests."""
+    print("\n" + "=" * 60)
+    print("nterm API Backend Tests")
+    print("=" * 60 + "\n")
+
+    results = []
+
+    results.append(("Imports", test_api_imports()))
+    results.append(("Platform Utils", test_platform_utils()))
+    results.append(("ANSI Filtering", test_ansi_filtering()))
+    results.append(("API Init", test_api_initialization()))
+    results.append(("REPL", test_repl_imports()))
+
+    print("=" * 60)
+    print("Test Summary")
+    print("=" * 60)
+
+    passed = 0
+    failed = 0
+    for name, result in results:
+        status = "✓ PASS" if result else "✗ FAIL"
+        print(f"  {status}: {name}")
+        if result:
+            passed += 1
+        else:
+            failed += 1
+
+    print()
+    print(f"Passed: {passed}/{len(results)}")
+    print(f"Failed: {failed}/{len(results)}")
+    print()
+
+    return failed == 0
+
+
+if __name__ == "__main__":
+    success = run_all_tests()
+    sys.exit(0 if success else 1)

{ntermqt-0.1.7.dist-info → ntermqt-0.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ntermqt
-Version: 0.1.7
+Version: 0.1.9
 Summary: Modern SSH terminal widget for PyQt6 with credential vault and jump host support
 Author: Scott Peterman
 License: GPL-3.0
@@ -85,10 +85,11 @@ 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)*
+**Scripting API**
 - Query device inventory and credentials programmatically
 - Built-in IPython console with API pre-loaded
-- CLI for shell scripts and automation
+- **Platform-aware commands** - one API, correct syntax everywhere
+- **Interactive REPL** with quick commands and structured output
 - Foundation for MCP tools and agentic workflows
 
 ---
@@ -111,7 +112,7 @@ nterm includes a built-in development console accessible via **Dev → IPython**
 
 ![IPython Console](https://raw.githubusercontent.com/scottpeterman/nterm/main/screenshots/ipython.png)
 
-![IPython Console](https://raw.githubusercontent.com/scottpeterman/nterm/main/screenshots/repl.png)
+![IPython Console](https://raw.githubusercontent.com/scottpeterman/nterm/main/screenshots/repl_dark3.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.
 
@@ -192,9 +193,9 @@ python -m nterm
 
 ---
 
-## Scripting API *(Experimental)*
+## Scripting API
 
-nterm includes a scripting API for programmatic access to your device inventory and credential vault. Use it from IPython, CLI, or Python scripts.
+nterm includes a full scripting API for programmatic access to your device inventory, credential vault, and network devices. Use it from IPython, CLI, or Python scripts.
 
 ### IPython Console
 
@@ -204,49 +205,103 @@ Open **Dev → IPython → Open in Tab** to get an interactive console with the
 api.devices()                    # List all saved devices
 api.search("leaf")               # Search by name/hostname
 api.devices("eng-*")             # Glob pattern filter
+api.folders()                    # List all folders
 
 api.unlock("vault-password")     # Unlock credential vault
 api.credentials()                # List credentials (metadata only)
 
+# Connect and execute commands
+with api.session("usa-leaf-1") as s:
+    result = api.send(s, "show version")
+    print(result.parsed_data)
+
 api.help()                       # Show all commands
 ```
 
-### CLI
+### Interactive REPL
 
-```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
+Start the REPL for interactive device exploration with platform-aware quick commands:
+
+```python
+api.repl()
+```
+
+```
+nterm> :unlock
+nterm> :connect usa-leaf-1
+
+📊 usa-leaf-1> :version
+──────────────────────────────────────────────────
+  Version:  15.2(4.0.55)E
+  Hardware: IOSv
+  Serial:   9J0PD0QB9W1
+  Uptime:   1 week, 4 days, 7 minutes
+──────────────────────────────────────────────────
+
+📊 usa-leaf-1> :neighbors
+Local Interface      Neighbor                       Remote Port
+----------------------------------------------------------------
+Gi0/0                usa-spine-2.lab.local          Ethernet1
+Gi0/1                usa-spine-1.lab.local          Ethernet1
+
+📊 usa-leaf-1> :interfaces
+[Rich formatted interface table]
 ```
 
+**Quick Commands:**
+- `:version` - Structured version info
+- `:config` - Running configuration
+- `:interfaces` - Interface status
+- `:neighbors` - CDP/LLDP neighbors (auto-detects)
+- `:bgp` - BGP summary
+- `:routes` - Routing table
+
 ### Python Scripts
 
 ```python
 from nterm.scripting import NTermAPI
 
 api = NTermAPI()
+api.unlock("vault-password")
 
-# Query devices
+# Context manager for automatic cleanup
 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}")
+    with api.session(device.name) as s:
+        # Platform-aware commands - works on Cisco, Arista, Juniper
+        result = api.send_platform_command(s, 'version')
+        print(f"{device.name}: {result.parsed_data[0].get('VERSION')}")
+
+# Try multiple commands until one works
+with api.session("router1") as s:
+    result = api.send_first(s, [
+        "show cdp neighbors detail",
+        "show lldp neighbors detail",
+    ])
 ```
 
-### Roadmap
+### 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
+```
 
-The scripting API is the foundation for:
+### Key Features
 
-- **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
+| Feature | Description |
+|---------|-------------|
+| **Context Manager** | `with api.session()` auto-disconnects |
+| **Platform-Aware** | `send_platform_command()` picks correct syntax |
+| **Fallback Commands** | `send_first()` tries alternatives |
+| **Structured Output** | TextFSM parsing to List[Dict] |
+| **ANSI Filtering** | Clean output, no escape sequences |
+| **Paging Detection** | Raises error if paging not disabled |
 
-See [scripting/README.md](nterm/scripting/README.md) for full API documentation.
+See [scripting/README_API_IPython.md](nterm/scripting/README_API_IPython.md) for full API documentation.
+See [scripting/README_REPL.md](nterm/scripting/README_REPL.md) for REPL documentation.
 
 ---
 
@@ -436,9 +491,14 @@ nterm/
 │   ├── resolver.py    # Pattern-based resolution
 │   └── manager_ui.py  # PyQt6 credential manager
 ├── manager/           # Session tree, connection dialogs
-└── scripting/         # API, CLI, automation support
-    ├── api.py         # NTermAPI class
-    └── cli.py         # nterm-cli entry point
+└── scripting/         # API, REPL, automation support
+    ├── api.py             # NTermAPI class
+    ├── models.py          # ActiveSession, CommandResult, DeviceInfo
+    ├── platform_data.py   # Platform commands and patterns
+    ├── platform_utils.py  # Platform detection, extraction helpers
+    ├── ssh_connection.py  # Low-level SSH with ANSI filtering
+    ├── repl.py            # NTermREPL command router
+    └── repl_interactive.py # Interactive REPL display
 ```
 
 ---

{ntermqt-0.1.7.dist-info → ntermqt-0.1.9.dist-info}/RECORD

@@ -14,16 +14,21 @@ nterm/manager/models.py,sha256=cvC2HzCRadNG1EYsnZN4C9YS6uolHGcUGGZtt-wzGF4,12237
 nterm/manager/settings.py,sha256=r6MTw_9r1Wl2UX_ALpXIuPbDvJ0D91Y8wRKq6Bfr_3g,9210
 nterm/manager/tree.py,sha256=I78wSjkSuyM6903II-XNyPug9saMSODUNBCHCDrq4ls,22397
 nterm/parser/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nterm/parser/api_help_dialog.py,sha256=qcmgNKjge8xwVNZeKZFu47Zn0SxZjyzE7cv9h91XGxg,16165
+nterm/parser/api_help_dialog.py,sha256=pz7AYCMZ8o0dr4NezOK7Rl7e7mJvcZUndnrTrJv17lo,23990
 nterm/parser/ntc_download_dialog.py,sha256=TGaMCxKBTIOhGNUoLEJLnD0uAnwYWdbHdb9PRZEY604,14151
 nterm/parser/tfsm_engine.py,sha256=6p4wrNa9tQRuCmWgsR4E3rZTprpLmii5PNjoGpCQBCw,7954
 nterm/parser/tfsm_fire.py,sha256=AHbN6p4HlgcYDjLWb67CF9YfMSTk-3aetMswmEZyRVc,9222
 nterm/parser/tfsm_fire_tester.py,sha256=h2CAqTS6ZNHMUr4di2DBRHAWbBGiUTliOvm5jVG4ltI,79146
 nterm/scripting/__init__.py,sha256=vxbODaXR0IPneja3BuDHmjsHzQg03tFWtHO4Rc6vCTk,1099
-nterm/scripting/api.py,sha256=9Gnxyscu3ZYNagYWGn_-5zX6O0-j8UJ_gM6PEbdHuEA,48540
+nterm/scripting/api.py,sha256=nWuANeYyT8mI1OsP9g3Z2lZohrrCpAZVss6t9Ba5Avg,39011
 nterm/scripting/cli.py,sha256=W2DK4ZnuutaArye_to7CBchg0ogClURxVbGsMdnj1y0,9187
-nterm/scripting/repl.py,sha256=VebSJu6dML7Ef0J4wLL8szdPESvsS2G8T5moyuF7nnU,14335
-nterm/scripting/repl_interactive.py,sha256=adpwRsbSfALS_0bwZPFayKUCyQefgvnO5uZwIWqKNFY,14880
+nterm/scripting/models.py,sha256=zX90xtFYz0fqIPc0G8mRaoiZ1aRLm0koiHIvklUBflg,6858
+nterm/scripting/platform_data.py,sha256=uCWBDS1HqmOdYNPojNlKBWLYhLiME9eoE0LWL-w6dkQ,10200
+nterm/scripting/platform_utils.py,sha256=_vb1tMstlD9pQ4blD2keAkVbs9lkbFlTBEavI5oMd3Q,18478
+nterm/scripting/repl.py,sha256=URcgs-c-bEYsw2JNCewEonNy1oLsGpzsBcq5xpYWseM,29152
+nterm/scripting/repl_interactive.py,sha256=yQ-XjyELBCE5t4Gk3hBnO8eZCbCXquddLBqcQIKPhY8,17870
+nterm/scripting/ssh_connection.py,sha256=p9EGPE3hgbceDVh7UdGz44cSi79Vl7g9Q4fKd-2T314,19270
+nterm/scripting/test_api_repl.py,sha256=deeA_epPnBxgDGYMKcyXEWQOOpIXQNjDZL01FmOpKvs,8762
 nterm/session/__init__.py,sha256=FkgHF1WPz78JBOWHSC7LLynG2NqoR6aanNTRlEzsO6I,1612
 nterm/session/askpass_ssh.py,sha256=U-frmLBIXwE2L5ZCEtai91G1dVRSWKLCtxn88t_PqGs,14083
 nterm/session/base.py,sha256=NNFt2uy-rTkwigrHcdnfREk_QZDxNe0CoP16C-7oIWs,2475
@@ -61,8 +66,8 @@ nterm/vault/manager_ui.py,sha256=qle-W40j6L_pOR0AaOCeyU8myizFTRkISNrloCn0H_Y,345
 nterm/vault/profile.py,sha256=qM9TJf68RKdjtxo-sJehO7wS4iTi2G26BKbmlmHLA5M,6246
 nterm/vault/resolver.py,sha256=GWB2YR9H1MH98RGQBKvitIsjWT_-wSMLuddZNz4wbns,7800
 nterm/vault/store.py,sha256=_0Lfe0WKjm3uSAtxgn9qAPlpBOLCuq9SVgzqsE_qaGQ,21199
-ntermqt-0.1.7.dist-info/METADATA,sha256=Q1Dz7d9n2AEzMW048T195_Zp062eYKSicxtqH1e1n9o,13624
-ntermqt-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ntermqt-0.1.7.dist-info/entry_points.txt,sha256=Gunr-_3w-aSpfqoMuGKM2PJSCRo9hZ7K1BksUtp1yd8,130
-ntermqt-0.1.7.dist-info/top_level.txt,sha256=bZdnNLTHNRNqo9jsOQGUWF7h5st0xW_thH0n2QOxWUo,6
-ntermqt-0.1.7.dist-info/RECORD,,
+ntermqt-0.1.9.dist-info/METADATA,sha256=ICYH7EjefVJLe_Hp-prpK8GPQE2TTqEaoX7-x2M0cOo,16040
+ntermqt-0.1.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ntermqt-0.1.9.dist-info/entry_points.txt,sha256=Gunr-_3w-aSpfqoMuGKM2PJSCRo9hZ7K1BksUtp1yd8,130
+ntermqt-0.1.9.dist-info/top_level.txt,sha256=bZdnNLTHNRNqo9jsOQGUWF7h5st0xW_thH0n2QOxWUo,6
+ntermqt-0.1.9.dist-info/RECORD,,