aws-ssh-utils 0.2.4__tar.gz → 0.2.5__tar.gz

{aws_ssh_utils-0.2.4 → aws_ssh_utils-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: aws-ssh-utils
-Version: 0.2.4
+Version: 0.2.5
 Summary: Easy AWS SSHing
 Project-URL: Homepage, https://github.com/mvanderlee/aws-ssh-utils
 Author-email: Michiel Vanderlee <jmt.vanderlee@gmail.com>
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -23,18 +24,14 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.11
 Requires-Dist: boto3
 Requires-Dist: click
-Requires-Dist: click-spinner
-Requires-Dist: coloredlogs
-Requires-Dist: environs
 Requires-Dist: loguru
 Requires-Dist: paramiko
+Requires-Dist: pyte>=0.8.2
 Requires-Dist: questionary
+Requires-Dist: requests>=2.34.2
+Requires-Dist: rich>=15.0.0
+Requires-Dist: textual>=8.2.8
 Requires-Dist: typing-extensions
-Provides-Extra: dev
-Requires-Dist: boto3-stubs[ec2,emr]; extra == 'dev'
-Provides-Extra: publish
-Requires-Dist: hatch>=1.7.0; extra == 'publish'
-Provides-Extra: test
 Description-Content-Type: text/markdown
 
 # AWS SSH Utils
@@ -51,12 +48,41 @@ aws_ssh ec2
 aws_ssh emr
 
 aws_ssh emr-all
+
+aws_ssh app
 ```
 
 This allows you to interactively SSH to an EC2 instance, EMR instance, or all EMR instances with TMUX.
 
 It utilizes [questionary](https://pypi.org/project/questionary/) to ask you which instance you want to connect to.
 
+## App
+
+Terminal UI to browse EC2 instances and EMR clusters, with SSH shells in tabs.
+It's the default command, so `aws_ssh` and `aws_ssh -p my-profile` launch it too.
+Each connection tries, in order: `~/.ssh/config`, SSH over AWS SSM (`session-manager-plugin`), opkssh (via instance/cluster tags),
+the instance's EC2 key found in `~/.ssh`, then your default keys/ssh-agent.
+Unknown host keys are accepted and appended to `~/.ssh/known_hosts`; changed host keys are rejected.
+
+```shell
+$ aws_ssh app --help
+Usage: aws_ssh app [OPTIONS]
+
+  Browse EC2 instances and EMR clusters, and open SSH shells in tabs.
+
+Options:
+  -p, --profile TEXT          Which AWS profile to use
+  -r, --region TEXT           Which AWS region to use
+  --scrollback INTEGER RANGE  Lines of scrollback per shell. Defaults to your
+                              tmux or Windows Terminal setting, else 1000.
+                              [x>=0]
+  --help                      Show this message and exit.
+```
+
+Scroll back with the mouse wheel or `shift+PgUp`/`shift+PgDn`; typing jumps back to the prompt.
+`F12` shows/hides the sidebar, `ctrl+w` closes a failed tab, `ctrl+q` quits. Every other key goes to the focused shell.
+Logs are viewable with `textual console`.
+
 ## EC2
 
 Select an instance from an interactive list. You can filter the instances by name.
@@ -73,7 +99,10 @@ Options:
   -r, --region TEXT     Which AWS region to use
   -u, --user TEXT       Which user to connect as
   --private / --public  Connect to the instance's private or public IP
-  -k, --key-file TEXT   Which key file to use to connect
+  -k, --key-file FILE   Which key file to use to connect
+  --scrollback INTEGER RANGE
+                        Lines of scrollback per shell. Defaults to your tmux or
+                        Windows Terminal setting, else 1000.  [x>=0]
   --help                Show this message and exit.
 ```
 
@@ -92,7 +121,10 @@ Options:
   -r, --region TEXT     Which AWS region to use
   -u, --user TEXT       Which user to connect as
   --private / --public  Connect to the instance's private or public IP
-  -k, --key-file TEXT   Which key file to use to connect
+  -k, --key-file FILE   Which key file to use to connect
+  --scrollback INTEGER RANGE
+                        Lines of scrollback per shell. Defaults to your tmux or
+                        Windows Terminal setting, else 1000.  [x>=0]
   --help                Show this message and exit.
 ```
 
@@ -113,6 +145,6 @@ Options:
   -r, --region TEXT     Which AWS region to use
   -u, --user TEXT       Which user to connect as
   --private / --public  Connect to the instance's private or public IP
-  -k, --key-file TEXT   Which key file to use to connect
+  -k, --key-file FILE   Which key file to use to connect
   --help                Show this message and exit.
 ```

{aws_ssh_utils-0.2.4 → aws_ssh_utils-0.2.5}/README.md

@@ -1,79 +1,114 @@
-# AWS SSH Utils
-
-[![Version](https://img.shields.io/pypi/v/aws-ssh-utils.svg)](https://pypi.org/project/aws-ssh-utils/)
-[![License](https://img.shields.io/pypi/l/aws-ssh-utils.svg)](#)
-[![Supported Python Versions](https://img.shields.io/pypi/pyversions/aws-ssh-utils.svg)](https://pypi.org/project/aws-ssh-utils/)
-
-```shell
-pip install aws-ssh-utils
-
-aws_ssh ec2
-
-aws_ssh emr
-
-aws_ssh emr-all
-```
-
-This allows you to interactively SSH to an EC2 instance, EMR instance, or all EMR instances with TMUX.
-
-It utilizes [questionary](https://pypi.org/project/questionary/) to ask you which instance you want to connect to.
-
-## EC2
-
-Select an instance from an interactive list. You can filter the instances by name.
-
-```shell
-$ aws_auth ec2 --help
-Usage: aws_ssh ec2 [OPTIONS]
-
-  Asks user which EC2 instance they want to connect to, then opens an
-  interactive SSH session to the instance
-
-Options:
-  -p, --profile TEXT    Which AWS profile to use
-  -r, --region TEXT     Which AWS region to use
-  -u, --user TEXT       Which user to connect as
-  --private / --public  Connect to the instance's private or public IP
-  -k, --key-file TEXT   Which key file to use to connect
-  --help                Show this message and exit.
-```
-
-## EMR
-
-Select the EMR cluster, instance group, and instance to connect to.
-
-```shell
-$ aws_ssh emr --help
-Usage: aws_ssh emr [OPTIONS]
-
-  Asks user which Cluster and EC2 instance they want to connect to, then opens an interactive SSH session to the instance
-
-Options:
-  -p, --profile TEXT    Which AWS profile to use
-  -r, --region TEXT     Which AWS region to use
-  -u, --user TEXT       Which user to connect as
-  --private / --public  Connect to the instance's private or public IP
-  -k, --key-file TEXT   Which key file to use to connect
-  --help                Show this message and exit.
-```
-
-## EMR All
-
-Select the EMR cluster to connect to. Then creates a new TMUX session with a window per instance. Each window will have an SSH connection to that instance open.
-
-```shell
-$ aws_ssh emr-all --help
-Usage: aws_ssh emr-all [OPTIONS]
-
-  Asks user which Cluster and EC2 instance they want to connect to, Then
-  prints a tmux cli statement that will open a new session with a window per
-  ec2 instance with ssh shell already opened.
-
-Options:
-  -p, --profile TEXT    Which AWS profile to use
-  -r, --region TEXT     Which AWS region to use
-  -u, --user TEXT       Which user to connect as
-  --private / --public  Connect to the instance's private or public IP
-  -k, --key-file TEXT   Which key file to use to connect
-  --help                Show this message and exit.
-```
+# AWS SSH Utils
+
+[![Version](https://img.shields.io/pypi/v/aws-ssh-utils.svg)](https://pypi.org/project/aws-ssh-utils/)
+[![License](https://img.shields.io/pypi/l/aws-ssh-utils.svg)](#)
+[![Supported Python Versions](https://img.shields.io/pypi/pyversions/aws-ssh-utils.svg)](https://pypi.org/project/aws-ssh-utils/)
+
+```shell
+pip install aws-ssh-utils
+
+aws_ssh ec2
+
+aws_ssh emr
+
+aws_ssh emr-all
+
+aws_ssh app
+```
+
+This allows you to interactively SSH to an EC2 instance, EMR instance, or all EMR instances with TMUX.
+
+It utilizes [questionary](https://pypi.org/project/questionary/) to ask you which instance you want to connect to.
+
+## App
+
+Terminal UI to browse EC2 instances and EMR clusters, with SSH shells in tabs.
+It's the default command, so `aws_ssh` and `aws_ssh -p my-profile` launch it too.
+Each connection tries, in order: `~/.ssh/config`, SSH over AWS SSM (`session-manager-plugin`), opkssh (via instance/cluster tags),
+the instance's EC2 key found in `~/.ssh`, then your default keys/ssh-agent.
+Unknown host keys are accepted and appended to `~/.ssh/known_hosts`; changed host keys are rejected.
+
+```shell
+$ aws_ssh app --help
+Usage: aws_ssh app [OPTIONS]
+
+  Browse EC2 instances and EMR clusters, and open SSH shells in tabs.
+
+Options:
+  -p, --profile TEXT          Which AWS profile to use
+  -r, --region TEXT           Which AWS region to use
+  --scrollback INTEGER RANGE  Lines of scrollback per shell. Defaults to your
+                              tmux or Windows Terminal setting, else 1000.
+                              [x>=0]
+  --help                      Show this message and exit.
+```
+
+Scroll back with the mouse wheel or `shift+PgUp`/`shift+PgDn`; typing jumps back to the prompt.
+`F12` shows/hides the sidebar, `ctrl+w` closes a failed tab, `ctrl+q` quits. Every other key goes to the focused shell.
+Logs are viewable with `textual console`.
+
+## EC2
+
+Select an instance from an interactive list. You can filter the instances by name.
+
+```shell
+$ aws_auth ec2 --help
+Usage: aws_ssh ec2 [OPTIONS]
+
+  Asks user which EC2 instance they want to connect to, then opens an
+  interactive SSH session to the instance
+
+Options:
+  -p, --profile TEXT    Which AWS profile to use
+  -r, --region TEXT     Which AWS region to use
+  -u, --user TEXT       Which user to connect as
+  --private / --public  Connect to the instance's private or public IP
+  -k, --key-file FILE   Which key file to use to connect
+  --scrollback INTEGER RANGE
+                        Lines of scrollback per shell. Defaults to your tmux or
+                        Windows Terminal setting, else 1000.  [x>=0]
+  --help                Show this message and exit.
+```
+
+## EMR
+
+Select the EMR cluster, instance group, and instance to connect to.
+
+```shell
+$ aws_ssh emr --help
+Usage: aws_ssh emr [OPTIONS]
+
+  Asks user which Cluster and EC2 instance they want to connect to, then opens an interactive SSH session to the instance
+
+Options:
+  -p, --profile TEXT    Which AWS profile to use
+  -r, --region TEXT     Which AWS region to use
+  -u, --user TEXT       Which user to connect as
+  --private / --public  Connect to the instance's private or public IP
+  -k, --key-file FILE   Which key file to use to connect
+  --scrollback INTEGER RANGE
+                        Lines of scrollback per shell. Defaults to your tmux or
+                        Windows Terminal setting, else 1000.  [x>=0]
+  --help                Show this message and exit.
+```
+
+## EMR All
+
+Select the EMR cluster to connect to. Then creates a new TMUX session with a window per instance. Each window will have an SSH connection to that instance open.
+
+```shell
+$ aws_ssh emr-all --help
+Usage: aws_ssh emr-all [OPTIONS]
+
+  Asks user which Cluster and EC2 instance they want to connect to, Then
+  prints a tmux cli statement that will open a new session with a window per
+  ec2 instance with ssh shell already opened.
+
+Options:
+  -p, --profile TEXT    Which AWS profile to use
+  -r, --region TEXT     Which AWS region to use
+  -u, --user TEXT       Which user to connect as
+  --private / --public  Connect to the instance's private or public IP
+  -k, --key-file FILE   Which key file to use to connect
+  --help                Show this message and exit.
+```

aws_ssh_utils-0.2.5/aws_ssh_utils/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.5"

aws_ssh_utils-0.2.5/aws_ssh_utils/cli_utils.py

@@ -0,0 +1,165 @@
+"""Shared helpers for the interactive (questionary based) commands."""
+
+import ctypes
+import functools
+import json
+import os
+import subprocess
+import sys
+from collections.abc import Callable
+from pathlib import Path
+from shutil import which
+from typing import ParamSpec, TypeVar
+
+import click
+import paramiko
+import questionary
+from botocore.exceptions import ClientError
+from loguru import logger
+from rich.console import Console
+from rich.markup import escape
+from rich.status import Status
+
+from aws_ssh_utils.commands.healthcheck import is_aws_ssm_installed, is_opkssh_installed
+from aws_ssh_utils.connection import Environment, Target, connect, open_shell_channel
+from aws_ssh_utils.terminal import ShellApp
+
+P = ParamSpec('P')
+R = TypeVar('R')
+
+DEFAULT_SCROLLBACK = 1000
+WINDOWS_TERMINAL_DEFAULT_SCROLLBACK = 9001
+WINDOWS_TERMINAL_SETTINGS = (
+    'Packages/Microsoft.WindowsTerminal_8wekyb3d8bbwe/LocalState/settings.json',
+    'Packages/Microsoft.WindowsTerminalPreview_8wekyb3d8bbwe/LocalState/settings.json',
+    'Microsoft/Windows Terminal/settings.json',
+)
+"""Relative to %LOCALAPPDATA%: Store, Store preview, and unpackaged installs."""
+
+console = Console(stderr=True)
+
+
+class ShellError(Exception):
+    def __init__(self, message: str, exit_code: int = 1):
+        super().__init__(message, exit_code)
+        self.message: str = message
+        self.exit_code: int = exit_code
+
+
+def spinner(message: str = '') -> Status:
+    return console.status(message, spinner='dots')
+
+
+def handle_errors(func: Callable[P, R]) -> Callable[P, R]:
+    """Log ShellErrors and AWS errors, and exit, instead of printing a traceback."""
+
+    @functools.wraps(func)
+    def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
+        try:
+            return func(*args, **kwargs)
+        except ShellError as e:
+            logger.error(e.message)
+            sys.exit(e.exit_code)
+        except ClientError as e:
+            if e.response.get('Error', {}).get('Code') == 'ExpiredTokenException':
+                logger.critical('Your AWS Token has expired. Please update and try again.')
+            else:
+                logger.error(e)
+            sys.exit(1)
+
+    return wrapper
+
+
+def set_terminal_title(title: str = ''):
+    if os.name == 'nt':
+        ctypes.windll.kernel32.SetConsoleTitleW(title)  # pyright: ignore[reportAttributeAccessIssue]
+    elif os.getenv('TMUX'):
+        sys.stdout.write(f"\33k{title}\33")
+        sys.stdout.flush()
+    else:
+        sys.stdout.write(f"\33]0;{title}\a")
+        sys.stdout.flush()
+
+
+def detect_environment(profile: str | None, region: str | None) -> Environment:
+    return Environment(
+        ssm_installed=is_aws_ssm_installed() and which('aws') is not None,
+        opkssh_installed=is_opkssh_installed(),
+        profile=profile,
+        region=region,
+    )
+
+
+def detect_scrollback() -> int:
+    """The scrollback of the terminal we run in, when it can be read (tmux, Windows Terminal)."""
+    if os.getenv('TMUX'):
+        try:
+            result = subprocess.run(
+                ['tmux', 'show-options', '-gv', 'history-limit'],  # noqa: S607
+                capture_output=True,
+                text=True,
+                check=True,
+                timeout=5,
+            )
+            return int(result.stdout)
+        except (OSError, subprocess.SubprocessError, ValueError) as e:
+            logger.debug(f"Could not read tmux history-limit: {e}")
+    if os.getenv('WT_SESSION'):
+        return windows_terminal_history_size()
+    return DEFAULT_SCROLLBACK
+
+
+def windows_terminal_history_size() -> int:
+    """`historySize` of the current Windows Terminal profile, falling back to the profile defaults."""
+    local_app_data = Path(os.getenv('LOCALAPPDATA', ''))
+    for settings_file in WINDOWS_TERMINAL_SETTINGS:
+        try:
+            settings = json.loads((local_app_data / settings_file).read_text(encoding='utf-8'))
+        except (OSError, ValueError):
+            continue
+        profiles = settings.get('profiles', {})
+        # Older settings files have a plain list of profiles
+        profile_list = profiles.get('list', []) if isinstance(profiles, dict) else profiles
+        defaults = profiles.get('defaults', {}) if isinstance(profiles, dict) else {}
+        profile_id = os.getenv('WT_PROFILE_ID', '').lower()
+        profile = next((p for p in profile_list if p.get('guid', '').lower() == profile_id), {})
+        return int(profile.get('historySize', defaults.get('historySize', WINDOWS_TERMINAL_DEFAULT_SCROLLBACK)))
+    return WINDOWS_TERMINAL_DEFAULT_SCROLLBACK
+
+
+scrollback_option = click.option(
+    '--scrollback',
+    type=click.IntRange(min=0),
+    default=None,
+    help="Lines of scrollback per shell. Defaults to your tmux or Windows Terminal setting, else 1000.",
+)
+
+
+def confirm_host_key(hostname: str, key: paramiko.PKey) -> bool:
+    logger.warning(f"Unknown {key.get_name()} host key for {hostname}: {key.fingerprint}")
+    return questionary.confirm("Continue and add host key?").unsafe_ask()
+
+
+def open_shell(target: Target, env: Environment, title: str, scrollback: int | None, initial_input: bytes = b''):
+    """Connect to the target, then show the shell full-screen until it closes.
+
+    `scrollback` defaults to the terminal's own setting, see `detect_scrollback`.
+    """
+    result = connect(target, env, on_output=logger.info, on_waiting=lambda: None, confirm_host_key=confirm_host_key)
+    if isinstance(result, list):
+        for line in result:
+            console.print(escape(line))
+        raise ShellError(f'Failed to connect to {target.user}@{target.ip}')
+
+    channel = open_shell_channel(result.client)
+    if initial_input:
+        channel.send(initial_input)
+
+    set_terminal_title(title)
+    # Logs, e.g. AWS SSM's stderr, would draw over the full-screen shell.
+    logger.disable('aws_ssh_utils')
+    try:
+        ShellApp(result.via, result.client, channel, detect_scrollback() if scrollback is None else scrollback).run()
+    finally:
+        logger.enable('aws_ssh_utils')
+        set_terminal_title()