htoolbox 0.1.0__py3-none-any.whl

htoolbox-0.1.0.data/scripts/codeit

@@ -0,0 +1,245 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Usage:
+#   host="100.123.68.125"
+#   remote_addr="127.0.0.1"   # or "0.0.0.0" or any ip bound on remote
+#   port=8000
+#   kill_remote_vscode "$host" "$remote_addr" "$port"
+#
+# Returns:
+#   0 = killed successfully
+#   1 = nothing to kill / no listener found
+#   2 = listener found but not Code/code-tunnel (skipped)
+#   3 = error (ssh failure / parsing failure)
+kill_remote_vscode_windows() {
+  local HOST="$1" REMOTE_ADDR="$2" PORT="$3"
+  local netstat_cmd="netstat -ano | findstr \"${REMOTE_ADDR}:${PORT}\" | findstr LISTENING || true"
+  local netline
+  netline=$(ssh "$HOST" "$netstat_cmd") || { echo "ERROR: ssh netstat failed" >&2; return 3; }
+  if [[ -z "$netline" ]]; then
+    echo "No listener found on ${REMOTE_ADDR}:${PORT} on ${HOST}."; return 1; fi
+  local pid
+  pid=$(printf '%s\n' "$netline" | awk '{print $NF}' | head -n1)
+  if [[ -z "$pid" ]]; then
+    echo "Failed to parse PID from netstat output:" >&2; printf '%s\n' "$netline" >&2; return 3; fi
+  local taskline tasklist_cmd="tasklist /FI \"PID eq ${pid}\" /FO CSV /NH"
+  taskline=$(ssh "$HOST" "$tasklist_cmd") || { echo "ERROR: ssh tasklist failed" >&2; return 3; }
+  if printf '%s\n' "$taskline" | grep -qi "No tasks are running"; then echo "PID $pid not present."; return 1; fi
+  local procname lower
+  procname=$(printf '%s\n' "$taskline" | awk -F',' '{gsub(/"/,"",$1); print $1}' | head -n1)
+  lower=$(printf '%s' "$procname" | tr '[:upper:]' '[:lower:]')
+  if [[ "$lower" == "code.exe" || "$lower" == "code" || "$lower" == "code-tunnel.exe" || "$lower" == "code-tunnel" ]]; then
+    echo "Killing windows PID $pid on $HOST ..."
+    ssh "$HOST" "taskkill /PID ${pid} /F" && { echo "Killed PID $pid."; return 0; }
+    echo "Failed to kill PID $pid." >&2; return 3
+  else
+    echo "PID $pid belongs to '$procname' — not Code/code-tunnel. Skipping kill."; return 2
+  fi
+}
+
+kill_remote_vscode_unix() {
+  # Linux / macOS: find PIDs listening on REMOTE_ADDR:PORT, prefer lsof then ss, validate by command line, then kill
+  local HOST="$1" REMOTE_ADDR="$2" PORT="$3"
+  # Build remote script safely using a heredoc with placeholder substitution to avoid local shell quoting issues
+  local REMOTE_SCRIPT
+  REMOTE_SCRIPT=$(cat <<'EOS'
+set -euo pipefail
+found_pids=""
+if command -v lsof >/dev/null 2>&1; then
+  found_pids=$(lsof -nP -iTCP:__PORT__ -sTCP:LISTEN -t 2>/dev/null || true)
+fi
+if [ -z "$found_pids" ] && command -v ss >/dev/null 2>&1; then
+  found_pids=$(ss -ltnp 2>/dev/null | awk -v port=__PORT__ '$4 ~ ":"port"$" {print}' | sed -n 's/.*pid=\([0-9]\+\).*/\1/p')
+fi
+if [ -z "$found_pids" ] && command -v pgrep >/dev/null 2>&1; then
+  found_pids=$(pgrep -f "serve-web.*(--port[= ]__PORT__|:__PORT__)" || true)
+fi
+killed_any=1
+if [ -n "$found_pids" ]; then
+  for pid in $found_pids; do
+    cmdline=$(ps -p "$pid" -o args= 2>/dev/null || true)
+    echo "$cmdline" | grep -qiE "(code(|-tunnel).*(serve-web)|serve-web)" || continue
+    echo "Killing PID $pid ($cmdline)"
+    kill -TERM "$pid" 2>/dev/null || true
+  done
+  sleep 0.5
+  for pid in $found_pids; do
+    if kill -0 "$pid" 2>/dev/null; then
+      kill -KILL "$pid" 2>/dev/null || true
+    fi
+  done
+  killed_any=0
+fi
+exit "$killed_any"
+EOS
+)
+  REMOTE_SCRIPT=${REMOTE_SCRIPT//__PORT__/$PORT}
+
+  if ssh "$HOST" bash -lc "$REMOTE_SCRIPT"; then
+    echo "Remote VS Code server cleaned up (Linux/macOS)."; return 0
+  else
+    echo "No matching VS Code server found to clean on $HOST (Linux/macOS)."; return 1
+  fi
+}
+
+
+# ----------------------------------
+# Defaults
+# ----------------------------------
+PORT=8000
+REMOTE_ADDR="127.0.0.1"
+REMOTE_PORT=8000
+BIND_HOST_IPV4=false
+KILL_MODE=false
+
+# ----------------------------------
+# Usage
+# ----------------------------------
+usage() {
+  cat <<EOF
+Usage: $0 [options] <host>
+
+Options:
+  -p, --port <port>         Local/forward port (default: 8000)
+  -r, --remote <addr[:p]>   Remote bind address and optional port (default: 127.0.0.1)
+  -b, --bindhost            Use detected IPv4 of <host> as remote bind address
+                            (mutually exclusive with --remote)
+  -k, --kill                Kill the VS Code server on the given port/host
+  -h, --help                Show this help
+
+Examples:
+  $0 myhost
+  $0 -p 8080 myhost
+  $0 -r 0.0.0.0 myhost
+  $0 -r 192.168.1.10:9000 myhost
+  $0 --kill -r 0.0.0.0:9000 myhost
+  $0 -b myhost              # bind the VS Code server to the host's IPv4
+EOF
+  exit 1
+}
+
+# ----------------------------------
+# Parse args
+# ----------------------------------
+REMOTE_SPEC=""
+while [[ $# -gt 0 ]]; do
+  case "$1" in
+    -p|--port)
+      shift; PORT="${1:-}"; [[ -z "$PORT" ]] && usage ;;
+    -r|--remote)
+      shift; REMOTE_SPEC="${1:-}"; [[ -z "$REMOTE_SPEC" ]] && usage ;;
+    -b|--bindhost)
+      BIND_HOST_IPV4=true ;;
+    -k|--kill)
+      KILL_MODE=true ;;
+    -h|--help)
+      usage ;;
+    -*)
+      echo "Unknown option: $1" >&2; usage ;;
+    *)
+      HOST="$1" ;;
+  esac
+  shift
+done
+
+[[ -z "${HOST:-}" ]] && usage
+
+# ----------------------------------
+# Validate mutual exclusivity
+# ----------------------------------
+if [[ "$BIND_HOST_IPV4" == true && -n "$REMOTE_SPEC" ]]; then
+  echo "Error: --bindhost (-b) cannot be used together with --remote (-r)." >&2
+  exit 1
+fi
+
+# ----------------------------------
+# Resolve host IPv4
+# ----------------------------------
+IPV4=$(ping -c 1 "$HOST" 2>/dev/null | grep -E -o "\(.*\):" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+") || true
+if [[ -n "$IPV4" ]]; then
+  echo "Host $HOST is mapped to $IPV4"
+else
+  IPV4="127.0.0.1"
+  echo "Failed to resolve IPv4 for $HOST; using 127.0.0.1"
+fi
+
+# ----------------------------------
+# Parse remote spec (ip[:port])
+# ----------------------------------
+if [[ -n "$REMOTE_SPEC" ]]; then
+  if [[ "$REMOTE_SPEC" == *:* ]]; then
+    REMOTE_ADDR="${REMOTE_SPEC%%:*}"
+    REMOTE_PORT="${REMOTE_SPEC##*:}"
+  elif [[ "$REMOTE_SPEC" =~ ^[0-9]+$ ]]; then
+    REMOTE_PORT="$REMOTE_SPEC"
+  else
+    REMOTE_ADDR="$REMOTE_SPEC"
+  fi
+fi
+
+# If user wants to bind to detected IPv4
+if [[ "$BIND_HOST_IPV4" == true ]]; then
+  REMOTE_ADDR="$IPV4"
+fi
+
+# ----------------------------------
+# Detect remote OS
+# ----------------------------------
+echo "Detecting OS on $HOST ..."
+REMOTE_OS=$(ssh -o BatchMode=yes -o ConnectTimeout=5 "$HOST" 'uname' | head -n 1)
+
+case "$REMOTE_OS" in
+  *[Ll]inux*)
+    OS_TYPE="linux"
+    CODE_CMD="code"
+    ;;
+  *[Dd]arwin*)
+    OS_TYPE="mac"
+    CODE_CMD="/Applications/Visual\\ Studio\\ Code.app/Contents/Resources/app/bin/code"
+    ;;
+  *[Mm][Ss][Yy][Ss]* | *[Mm][Ii][Nn][Gg][Ww]* | *[Cc][Yy][Gg][Ww]* | *[Ww]indows*)
+    OS_TYPE="windows"
+    CODE_CMD="\"d:/App/Microsoft VS Code/bin/code\""
+    ;;
+  *)
+    OS_TYPE="unknown"
+    CODE_CMD="code"
+    ;;
+esac
+
+echo "Detected remote OS: $OS_TYPE ($REMOTE_OS)"
+
+cleanup_remote() {
+  echo "Cleaning up remote VS Code server on $HOST (host: $REMOTE_ADDR, port: $REMOTE_PORT)..."
+  case "$OS_TYPE" in
+    windows)
+      kill_remote_vscode_windows "$HOST" "$REMOTE_ADDR" "$REMOTE_PORT" || true ;;
+    linux|mac)
+      kill_remote_vscode_unix "$HOST" "$REMOTE_ADDR" "$REMOTE_PORT" || true ;;
+    *)
+      echo "Unknown remote OS; attempted generic cleanup..." ;;
+  esac
+}
+
+# Ensure we attempt cleanup on Ctrl+C or script exit
+trap cleanup_remote INT TERM EXIT
+
+# ----------------------------------
+# Kill mode (explicit command)
+# ----------------------------------
+if [[ "$KILL_MODE" == true ]]; then
+  cleanup_remote
+  exit 0
+fi
+
+
+echo -e "\n------------------------------------------------------------------\n"
+
+
+# ----------------------------------
+# Start VS Code server
+# ----------------------------------
+echo "Starting VS Code server on $HOST (bind ${REMOTE_ADDR}:${REMOTE_PORT})..."
+ssh -L "localhost:${PORT}:${REMOTE_ADDR}:${REMOTE_PORT}" "$HOST" \
+  "${CODE_CMD} serve-web --without-connection-token --accept-server-license-terms --host ${REMOTE_ADDR} --port ${REMOTE_PORT}"

htoolbox-0.1.0.dist-info/METADATA

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: htoolbox
+Version: 0.1.0
+Summary: This package includes various tools for developers.
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# HToolbox
+
+This repository provides some useful tools that fit my developing habits.
+
+## Install
+
+To install locally (editable mode) and get the `tmuxer` command:
+
+```bash
+pip install -e .
+```
+
+Or to install from source (non-editable):
+
+```bash
+pip install .
+```
+
+## tmuxer
+
+Run the installed command:
+
+```bash
+tmuxer -s mysession -n 3 --layout ev
+```
+
+This will start (or attach) to a tmux session named `mysession` with 3 panes using the `even-vertical` layout (`ev`).
+
+## codeit
+
+This tool is a quick script for starting vscode server on a remote server, and utilizing SSH port forwarding to access it locally.
+
+```bash
+codeit <remote-host>
+```

htoolbox-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+tmuxer.py,sha256=ZM_eKNb0XAY5rgsSX_hs6f9OrDFqf3q39WaN0IqvIZk,3090
+htoolbox-0.1.0.data/scripts/codeit,sha256=hC5Jib7Ka8h5rgRnM4Jy-QFJLdrgVgKiqgFCdunk6oE,7904
+htoolbox-0.1.0.dist-info/licenses/LICENSE,sha256=518WNThsP4IMvqMZ4PM-gXwqPvBwBlF4LvUmAJjVdDM,1070
+htoolbox-0.1.0.dist-info/METADATA,sha256=7x7hq-aY88U9YaqWz1wo87cBZ7TuPhj0ZApJlT1Ez6o,871
+htoolbox-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+htoolbox-0.1.0.dist-info/entry_points.txt,sha256=Lme2V1g3rRAq8tyxNmu70eS80h-LBeP03giTfP8E4fA,39
+htoolbox-0.1.0.dist-info/top_level.txt,sha256=H5dSXvsTcYsU3PtS2Ya1w-GQct2fWxmbFHJ61GnP92E,7
+htoolbox-0.1.0.dist-info/RECORD,,

htoolbox-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

htoolbox-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+tmuxer = tmuxer:main

htoolbox-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Zhanghan Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

htoolbox-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+tmuxer

tmuxer.py

@@ -0,0 +1,90 @@
+import os
+import argparse
+import sys
+
+
+def start_tmux_session(session_name, window_name=None, pane_index=None, new_panes=1, layout="even-vertical"):
+    """Start and attach to a tmux session.
+
+    This function uses the `tmux` command-line tool. It is designed to be
+    called from the CLI entry point `main()` below, but can also be imported
+    and used programmatically.
+    """
+    # Start a new tmux session detached
+    os.system(f"tmux new-session -d -s {session_name}")
+
+    # Create a new window if specified
+    if window_name:
+        os.system(f"tmux new-window -t {session_name} -n {window_name}")
+
+    # Create new panes if specified
+    for i in range(1, new_panes):
+        os.system(f"tmux split-window -t {session_name}")
+        os.system(f"tmux select-layout -t {session_name} {layout}")
+
+    # Export IID environment variable into each pane
+    for i in range(new_panes):
+        os.system(f"tmux send-keys -t {session_name}.{i} 'export IID={i}' C-m")
+
+    # Select the specified pane if provided
+    if pane_index is not None:
+        os.system(f"tmux select-pane -t {session_name}:{pane_index}")
+
+    # Attach to the tmux session
+    os.system(f"tmux attach-session -t {session_name}")
+
+
+def _normalize_layout(layout_arg: str) -> str:
+    v = layout_arg.lower().strip()
+    if v == "eh":
+        return "even-horizontal"
+    if v == "ev":
+        return "even-vertical"
+    if v == "mh":
+        return "main-horizontal"
+    if v == "mv":
+        return "main-vertical"
+    if v == "t":
+        return "tiled"
+    return layout_arg
+
+
+def main():
+    """Console entry point for the `tmuxer` command.
+
+    Accepts an optional argv list (for testing). Returns 0 on success, may
+    raise exceptions for misuse.
+    """
+    parser = argparse.ArgumentParser(description="Tmux session starter")
+    parser.add_argument("-n", "--num_panes", type=int, required=True, help="Number of new panes to create")
+    parser.add_argument("-s", "--session", type=str, required=True, help="Name of the tmux session")
+    parser.add_argument("-w", "--window", type=str, help="Name of the tmux window")
+    parser.add_argument("-p", "--pane", type=int, help="Index of the tmux pane")
+    parser.add_argument("--layout", type=str, default="even-vertical", help="Layout for the tmux panes")
+    parser.add_argument(
+        "--kill", action="store_true", help="Kill existing tmux session with the same name before starting a new one"
+    )
+
+    args = parser.parse_args()
+
+    if args.kill and args.session:
+        # Prefer to silence output from tmux kill-session
+        os.system(f"tmux kill-session -t {args.session} >/dev/null 2>&1")
+
+    if args.num_panes < 1:
+        raise ValueError("Number of new panes must be at least 1")
+
+    layout = _normalize_layout(args.layout)
+
+    # If session name is not provided, let tmux create a session with default name
+    start_tmux_session(
+        session_name=args.session,
+        window_name=args.window,
+        pane_index=args.pane,
+        new_panes=args.num_panes,
+        layout=layout,
+    )
+
+
+if __name__ == "__main__":
+    main()