aws-bootstrap-g4dn 0.6.0__tar.gz → 0.8.0__tar.gz

{aws_bootstrap_g4dn-0.6.0 → aws_bootstrap_g4dn-0.8.0}/.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
     - id: end-of-file-fixer
     - id: trailing-whitespace
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.14.7
+  rev: v0.15.0
   hooks:
     # Run the linter.
     - id: ruff-check
@@ -28,7 +28,7 @@ repos:
   rev: v1.19.0
   hooks:
     - id: mypy
-      additional_dependencies: [types-pyyaml>=6.0.12]
+      additional_dependencies: [types-pyyaml>=6.0.12, types-tabulate>=0.9]
 - repo: local
   hooks:
   - id: pytest

{aws_bootstrap_g4dn-0.6.0 → aws_bootstrap_g4dn-0.8.0}/CLAUDE.md

@@ -13,6 +13,8 @@ Target workflows: Jupyter server-client, VSCode Remote SSH, and NVIDIA Nsight re
 - **Python 3.12+** with **uv** package manager (astral-sh/uv) — used for venv creation, dependency management, and running the project
 - **boto3** — AWS SDK for EC2 provisioning (AMI lookup, security groups, instance launch, waiters)
 - **click** — CLI framework with built-in color support (`click.secho`, `click.style`)
+- **pyyaml** — YAML serialization for `--output yaml`
+- **tabulate** — Table formatting for `--output table`
 - **setuptools + setuptools-scm** — build backend with git-tag-based versioning (configured in pyproject.toml)
 - **AWS CLI v2** with a configured AWS profile (`AWS_PROFILE` env var or `--profile` flag)
 - **direnv** for automatic venv activation (`.envrc` sources `.venv/bin/activate`)
@@ -34,6 +36,7 @@ aws_bootstrap/
     config.py            # LaunchConfig dataclass with defaults
     ec2.py               # AMI lookup, security group, instance launch/find/terminate, polling, spot pricing, EBS volume ops
     gpu.py               # GPU architecture mapping and GpuInfo dataclass
+    output.py            # Output formatting: OutputFormat enum, emit(), echo/secho wrappers for structured output
     ssh.py               # SSH key pair import, SSH readiness check, remote setup, ~/.ssh/config management, GPU queries, EBS mount
     resources/           # Non-Python artifacts SCP'd to remote instances
         __init__.py
@@ -48,6 +51,7 @@ aws_bootstrap/
         test_config.py
         test_cli.py
         test_ec2.py
+        test_output.py
         test_gpu.py
         test_ssh_config.py
         test_ssh_gpu.py
@@ -62,10 +66,12 @@ Entry point: `aws-bootstrap = "aws_bootstrap.cli:main"` (installed via `uv sync`
 
 ## CLI Commands
 
+**Global option:** `--output` / `-o` controls output format: `text` (default, human-readable with color), `json`, `yaml`, `table`. Structured formats (json/yaml/table) suppress all progress messages and emit machine-readable output. Commands requiring confirmation (`terminate`, `cleanup`) require `--yes` in structured modes.
+
 - **`launch`** — provisions an EC2 instance (spot by default, falls back to on-demand on capacity errors); adds SSH config alias (e.g. `aws-gpu1`) to `~/.ssh/config`; `--python-version` controls which Python `uv` installs in the remote venv; `--ssh-port` overrides the default SSH port (22) for security group ingress, connection checks, and SSH config; `--ebs-storage SIZE` creates and attaches a new gp3 EBS data volume (mounted at `/data`); `--ebs-volume-id ID` attaches an existing EBS volume (mutually exclusive with `--ebs-storage`)
 - **`status`** — lists all non-terminated instances (including `shutting-down`) with type, IP, SSH alias, EBS data volumes, pricing (spot price/hr or on-demand), uptime, and estimated cost for running spot instances; `--gpu` flag queries GPU info via SSH, reporting both CUDA toolkit version (from `nvcc`) and driver-supported max (from `nvidia-smi`); `--instructions` (default: on) prints connection commands (SSH, Jupyter tunnel, VSCode Remote SSH, GPU benchmark) for each running instance; suppress with `--no-instructions`
 - **`terminate`** — terminates instances by ID or SSH alias (e.g. `aws-gpu1`, resolved via `~/.ssh/config`), or all aws-bootstrap instances in the region if no arguments given; removes SSH config aliases; deletes associated EBS data volumes by default; `--keep-ebs` preserves volumes and prints reattach commands
-- **`cleanup`** — removes stale `~/.ssh/config` entries for terminated/non-existent instances; compares managed SSH config blocks against live EC2 instances; `--dry-run` previews removals without modifying config; `--yes` skips the confirmation prompt
+- **`cleanup`** — removes stale `~/.ssh/config` entries for terminated/non-existent instances; compares managed SSH config blocks against live EC2 instances; `--include-ebs` also finds and deletes orphan EBS data volumes (volumes in `available` state whose linked instance no longer exists); `--dry-run` previews removals without modifying config; `--yes` skips the confirmation prompt
 - **`list instance-types`** — lists EC2 instance types matching a family prefix (default: `g4dn`), showing vCPUs, memory, and GPU info
 - **`list amis`** — lists available AMIs matching a name pattern (default: Deep Learning Base OSS Nvidia Driver GPU AMIs), sorted newest-first
 
@@ -94,6 +100,18 @@ uv run pytest
 
 Use `uv add <package>` to add dependencies and `uv add --group dev <package>` for dev dependencies.
 
+## Structured Output Architecture
+
+The `--output` option uses a context-aware suppression pattern via `aws_bootstrap/output.py`:
+
+- **`output.echo()` / `output.secho()`** — wrap `click.echo`/`click.secho`; silent in non-text modes. Used in `ec2.py` and `ssh.py` for progress messages.
+- **`is_text(ctx)`** — checks if the current output format is text. Used in `cli.py` to guard text-only blocks.
+- **`emit(data, headers=..., ctx=...)`** — dispatches structured data to JSON/YAML/table renderers. No-op in text mode.
+- **CLI helper guards** — `step()`, `info()`, `val()`, `success()`, `warn()` in `cli.py` check `is_text()` and return early in structured modes.
+- Each CLI command builds a result dict alongside existing logic, emits it via `emit()` for non-text formats, and falls through to text output for text mode.
+- **Confirmation prompts** (`terminate`, `cleanup`) require `--yes` in structured modes to avoid corrupting output.
+- The spot-fallback `click.confirm()` in `ec2.py` auto-confirms in structured modes.
+
 ## CUDA-Aware PyTorch Installation
 
 `remote_setup.sh` detects the CUDA toolkit version on the instance (via `nvcc`, falling back to `nvidia-smi`) and installs PyTorch from the matching CUDA wheel index (`https://download.pytorch.org/whl/cu{TAG}`). This ensures `torch.version.cuda` matches the system's CUDA toolkit, which is required for compiling custom CUDA extensions with `nvcc`.

{aws_bootstrap_g4dn-0.6.0 → aws_bootstrap_g4dn-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aws-bootstrap-g4dn
-Version: 0.6.0
+Version: 0.8.0
 Summary: Bootstrap AWS EC2 GPU instances for hybrid local-remote development
 Author: Adam Ever-Hadani
 License-Expression: MIT
@@ -15,6 +15,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: boto3>=1.35
 Requires-Dist: click>=8.1
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: tabulate>=0.9.0
 Dynamic: license-file
 
 # aws-bootstrap-g4dn
@@ -232,6 +234,30 @@ Then install the [Nsight VSCE extension](https://marketplace.visualstudio.com/it
 
 See [Nsight remote profiling guide](docs/nsight-remote-profiling.md) for more details on CUDA debugging and profiling workflows.
 
+### 📤 Structured Output
+
+All commands support `--output` / `-o` for machine-readable output — useful for scripting, piping to `jq`, or LLM tool-use:
+
+```bash
+# JSON output (pipe to jq)
+aws-bootstrap -o json status
+aws-bootstrap -o json status | jq '.instances[0].instance_id'
+
+# YAML output
+aws-bootstrap -o yaml status
+
+# Table output
+aws-bootstrap -o table status
+
+# Works with all commands
+aws-bootstrap -o json list instance-types | jq '.[].instance_type'
+aws-bootstrap -o json launch --dry-run
+aws-bootstrap -o json terminate --yes
+aws-bootstrap -o json cleanup --dry-run
+```
+
+Supported formats: `text` (default, human-readable with color), `json`, `yaml`, `table`. Commands that require confirmation (`terminate`, `cleanup`) require `--yes` in structured output modes.
+
 ### 📋 Listing Resources
 
 ```bash
@@ -291,6 +317,12 @@ aws-bootstrap cleanup
 # Preview what would be removed without modifying config
 aws-bootstrap cleanup --dry-run
 
+# Also find and delete orphan EBS data volumes
+aws-bootstrap cleanup --include-ebs
+
+# Preview orphan volumes without deleting
+aws-bootstrap cleanup --include-ebs --dry-run
+
 # Skip confirmation prompt
 aws-bootstrap cleanup --yes
 ```
@@ -324,6 +356,7 @@ Key behaviors:
 - New volumes are formatted as ext4; existing volumes are mounted as-is
 - Volumes are tagged for automatic discovery by `status` and `terminate`
 - `terminate` deletes data volumes by default; use `--keep-ebs` to preserve them
+- **Orphan cleanup** — use `aws-bootstrap cleanup --include-ebs` to find and delete orphan volumes (e.g. from spot interruptions or forgotten `--keep-ebs` volumes). Use `--dry-run` to preview
 - **Spot-safe** — data volumes survive spot interruptions. If AWS reclaims your instance, the volume detaches automatically and can be reattached to a new instance with `--ebs-volume-id`
 - EBS volumes must be in the same availability zone as the instance
 - Mount failures are non-fatal — the instance remains usable

aws_bootstrap_g4dn-0.6.0/aws_bootstrap_g4dn.egg-info/PKG-INFO → aws_bootstrap_g4dn-0.8.0/README.md

@@ -1,22 +1,3 @@
-Metadata-Version: 2.4
-Name: aws-bootstrap-g4dn
-Version: 0.6.0
-Summary: Bootstrap AWS EC2 GPU instances for hybrid local-remote development
-Author: Adam Ever-Hadani
-License-Expression: MIT
-Project-URL: Homepage, https://github.com/promptromp/aws-bootstrap-g4dn
-Project-URL: Issues, https://github.com/promptromp/aws-bootstrap-g4dn/issues
-Keywords: aws,ec2,gpu,cuda,deep-learning,spot-instances,cli
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: boto3>=1.35
-Requires-Dist: click>=8.1
-Dynamic: license-file
-
 # aws-bootstrap-g4dn
 
 --------------------------------------------------------------------------------
@@ -232,6 +213,30 @@ Then install the [Nsight VSCE extension](https://marketplace.visualstudio.com/it
 
 See [Nsight remote profiling guide](docs/nsight-remote-profiling.md) for more details on CUDA debugging and profiling workflows.
 
+### 📤 Structured Output
+
+All commands support `--output` / `-o` for machine-readable output — useful for scripting, piping to `jq`, or LLM tool-use:
+
+```bash
+# JSON output (pipe to jq)
+aws-bootstrap -o json status
+aws-bootstrap -o json status | jq '.instances[0].instance_id'
+
+# YAML output
+aws-bootstrap -o yaml status
+
+# Table output
+aws-bootstrap -o table status
+
+# Works with all commands
+aws-bootstrap -o json list instance-types | jq '.[].instance_type'
+aws-bootstrap -o json launch --dry-run
+aws-bootstrap -o json terminate --yes
+aws-bootstrap -o json cleanup --dry-run
+```
+
+Supported formats: `text` (default, human-readable with color), `json`, `yaml`, `table`. Commands that require confirmation (`terminate`, `cleanup`) require `--yes` in structured output modes.
+
 ### 📋 Listing Resources
 
 ```bash
@@ -291,6 +296,12 @@ aws-bootstrap cleanup
 # Preview what would be removed without modifying config
 aws-bootstrap cleanup --dry-run
 
+# Also find and delete orphan EBS data volumes
+aws-bootstrap cleanup --include-ebs
+
+# Preview orphan volumes without deleting
+aws-bootstrap cleanup --include-ebs --dry-run
+
 # Skip confirmation prompt
 aws-bootstrap cleanup --yes
 ```
@@ -324,6 +335,7 @@ Key behaviors:
 - New volumes are formatted as ext4; existing volumes are mounted as-is
 - Volumes are tagged for automatic discovery by `status` and `terminate`
 - `terminate` deletes data volumes by default; use `--keep-ebs` to preserve them
+- **Orphan cleanup** — use `aws-bootstrap cleanup --include-ebs` to find and delete orphan volumes (e.g. from spot interruptions or forgotten `--keep-ebs` volumes). Use `--dry-run` to preview
 - **Spot-safe** — data volumes survive spot interruptions. If AWS reclaims your instance, the volume detaches automatically and can be reattached to a new instance with `--ebs-volume-id`
 - EBS volumes must be in the same availability zone as the instance
 - Mount failures are non-fatal — the instance remains usable