osc52 0.1.0__tar.gz

osc52-0.1.0/.gitignore

@@ -0,0 +1,39 @@
+# Byte-compiled / optimized
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+wheels/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Test / coverage
+.pytest_cache/
+.tox/
+.nox/
+.coverage
+.coverage.*
+htmlcov/
+.cache
+
+# Type checkers / linters
+.mypy_cache/
+.ruff_cache/
+.dmypy.json
+
+# Editors / OS
+.idea/
+.vscode/
+*.swp
+.DS_Store
+Thumbs.db

osc52-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 yeyi0003
+
+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.

osc52-0.1.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: osc52
+Version: 0.1.0
+Summary: Copy stdin or arguments to the system clipboard via the OSC 52 terminal escape sequence — works over SSH + tmux.
+Project-URL: Homepage, https://github.com/yeyi0003/osc52
+Project-URL: Repository, https://github.com/yeyi0003/osc52
+Author: yeyi0003
+License: MIT
+License-File: LICENSE
+Keywords: cli,clipboard,copy,osc52,ssh,terminal,tmux
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Terminals
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# osc52
+
+Copy stdin (or arguments) to the system clipboard via the **OSC 52** terminal
+escape sequence. Designed to work over **SSH + tmux**: the escape is written to
+stderr, streamed back to your *local* terminal, and routed to your *local*
+clipboard — so `ssh server "nvidia-smi | osc52"` copies the remote output to
+your local machine, no remote clipboard tool required.
+
+This is the Python port of the Go tool of the same name, distributed on PyPI so
+`pip install osc52` gives you the `osc52` command directly.
+
+## Install
+
+```bash
+pip install osc52
+```
+
+This installs an `osc52` executable onto your `PATH` (an `osc52.exe` shim on
+Windows).
+
+## Usage
+
+```bash
+# Default: echo input to stdout AND copy to clipboard.
+nvidia-smi | osc52
+
+# Copy only, no echo.
+nvidia-smi | osc52 -q
+
+# Copy a file.
+osc52 < config.yaml
+
+# Copy a literal string.
+osc52 "https://example.com/token"
+```
+
+## How it works
+
+```
+stdin/argv ──▶ echo to stdout (visible) ─────────────────▶ terminal / pipe
+          └─▶ base64 ─▶ ESC ] 52 ; c ; <b64> BEL ─▶ stderr ─▶ terminal
+                                                              (parses OSC 52
+                                                               → local clipboard)
+```
+
+- **Echo** goes to **stdout** so downstream pipes stay clean of escape sequences.
+- **OSC 52** goes to **stderr** so the terminal still parses it, but it never
+  pollutes piped output.
+- Large payloads are split into ≤32KB base64 chunks; terminals accumulate
+  same-selection sequences into the clipboard.
+
+## Options
+
+| Flag | Meaning |
+|------|---------|
+| `-q, --quiet` | Do not echo input to stdout |
+| `--version` | Print version |
+| `-h, --help` | Help |
+
+## Terminal support
+
+OSC 52 is supported by Windows Terminal, iTerm2, kitty, Alacritty, WezTerm,
+foot, and recent GNOME Terminal. In tmux, ensure `set -g set-clipboard on`.
+
+## License
+
+MIT

osc52-0.1.0/README.md

@@ -0,0 +1,67 @@
+# osc52
+
+Copy stdin (or arguments) to the system clipboard via the **OSC 52** terminal
+escape sequence. Designed to work over **SSH + tmux**: the escape is written to
+stderr, streamed back to your *local* terminal, and routed to your *local*
+clipboard — so `ssh server "nvidia-smi | osc52"` copies the remote output to
+your local machine, no remote clipboard tool required.
+
+This is the Python port of the Go tool of the same name, distributed on PyPI so
+`pip install osc52` gives you the `osc52` command directly.
+
+## Install
+
+```bash
+pip install osc52
+```
+
+This installs an `osc52` executable onto your `PATH` (an `osc52.exe` shim on
+Windows).
+
+## Usage
+
+```bash
+# Default: echo input to stdout AND copy to clipboard.
+nvidia-smi | osc52
+
+# Copy only, no echo.
+nvidia-smi | osc52 -q
+
+# Copy a file.
+osc52 < config.yaml
+
+# Copy a literal string.
+osc52 "https://example.com/token"
+```
+
+## How it works
+
+```
+stdin/argv ──▶ echo to stdout (visible) ─────────────────▶ terminal / pipe
+          └─▶ base64 ─▶ ESC ] 52 ; c ; <b64> BEL ─▶ stderr ─▶ terminal
+                                                              (parses OSC 52
+                                                               → local clipboard)
+```
+
+- **Echo** goes to **stdout** so downstream pipes stay clean of escape sequences.
+- **OSC 52** goes to **stderr** so the terminal still parses it, but it never
+  pollutes piped output.
+- Large payloads are split into ≤32KB base64 chunks; terminals accumulate
+  same-selection sequences into the clipboard.
+
+## Options
+
+| Flag | Meaning |
+|------|---------|
+| `-q, --quiet` | Do not echo input to stdout |
+| `--version` | Print version |
+| `-h, --help` | Help |
+
+## Terminal support
+
+OSC 52 is supported by Windows Terminal, iTerm2, kitty, Alacritty, WezTerm,
+foot, and recent GNOME Terminal. In tmux, ensure `set -g set-clipboard on`.
+
+## License
+
+MIT

osc52-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "osc52"
+version = "0.1.0"
+description = "Copy stdin or arguments to the system clipboard via the OSC 52 terminal escape sequence — works over SSH + tmux."
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+authors = [{ name = "yeyi0003" }]
+keywords = ["clipboard", "osc52", "terminal", "ssh", "tmux", "copy", "cli"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Terminals",
+    "Topic :: Utilities",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/yeyi0003/osc52"
+Repository = "https://github.com/yeyi0003/osc52"
+
+[project.scripts]
+osc52 = "osc52.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/osc52"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/osc52", "README.md", "LICENSE", "pyproject.toml", "tests"]

osc52-0.1.0/src/osc52/__init__.py

@@ -0,0 +1,3 @@
+"""osc52 — copy to the system clipboard via the OSC 52 terminal escape."""
+
+__version__ = "0.1.0"

osc52-0.1.0/src/osc52/cli.py

@@ -0,0 +1,113 @@
+"""osc52 — copy stdin (or arguments) to the system clipboard via OSC 52.
+
+Designed to work over SSH + tmux: the escape sequence is written to stderr so
+the controlling terminal parses it and routes the payload to the *local*
+clipboard, while the original data is echoed to stdout (kept clean for any
+downstream pipe).
+
+Behavior:
+  * Default: echo input to stdout AND copy via OSC 52 to stderr.
+  * -q/--quiet:  copy only, do not echo.
+
+This is a Python port of the Go tool github.com/yeyi0003/osc52.
+"""
+
+from __future__ import annotations
+
+import argparse
+import base64
+import sys
+
+from . import __version__
+
+# Largest base64 chunk emitted in a single OSC 52 sequence. Some terminals cap a
+# single sequence; 32KB is a safe midpoint that keeps big copies working by
+# sending multiple same-selection sequences, which terminals accumulate.
+MAX_PAYLOAD = 32 * 1024
+
+OSC_START = b"\x1b]52;c;"
+OSC_END = b"\x07"
+
+PROG = "osc52"
+
+
+def _eprint(msg: str) -> None:
+    """Print a diagnostic line to stderr."""
+    print(f"{PROG}: {msg}", file=sys.stderr)
+
+
+def write_osc52(buf, data: bytes) -> None:
+    """Emit one or more OSC 52 sequences to a binary writer.
+
+    Large payloads are split into MAX_PAYLOAD-sized base64 chunks; terminals
+    accumulate same-selection sequences into the clipboard.
+    """
+    b64 = base64.standard_b64encode(data).decode("ascii") if data else ""
+    chunks = 0
+    for i in range(0, len(b64), MAX_PAYLOAD):
+        chunk = b64[i : i + MAX_PAYLOAD].encode("ascii")
+        buf.write(OSC_START + chunk + OSC_END)
+        chunks += 1
+    buf.flush()
+    if chunks > 1:
+        _eprint(f"sent {chunks} chunks")
+
+
+def _build_parser() -> argparse.ArgumentParser:
+    p = argparse.ArgumentParser(
+        prog=PROG,
+        description="copy stdin/args to the clipboard via OSC 52",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog=(
+            "examples:\n"
+            "  nvidia-smi | osc52            # echo + copy\n"
+            "  nvidia-smi | osc52 -q         # copy only, no echo\n"
+            "  osc52 < file                  # copy file contents\n"
+            '  osc52 "some text"             # copy a literal string\n'
+        ),
+    )
+    p.add_argument("-q", "--quiet", action="store_true",
+                   help="do not echo input to stdout")
+    p.add_argument("--version", action="version",
+                   version=f"{PROG} {__version__}")
+    p.add_argument("args", nargs="*", help=argparse.SUPPRESS)
+    return p
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = _build_parser()
+    ns = parser.parse_args(argv)
+
+    # Gather the data to copy.
+    if ns.args:
+        # Arguments: join with spaces. Warn if stdin is also piped.
+        if not sys.stdin.isatty():
+            _eprint("warning: arguments given, ignoring piped stdin")
+        data = " ".join(ns.args).encode("utf-8", "surrogateescape") + b"\n"
+    else:
+        # Read all of stdin as raw bytes.
+        data = sys.stdin.buffer.read()
+
+    # Echo to stdout unless quiet. Done before copying so the user sees output
+    # even if the copy path fails downstream.
+    if not ns.quiet:
+        try:
+            sys.stdout.buffer.write(data)
+            sys.stdout.buffer.flush()
+        except BrokenPipeError:
+            pass
+        except OSError as exc:
+            _eprint(f"write stdout: {exc}")
+            return 1
+
+    # Copy. OSC 52 goes to stderr so it does not pollute echoed stdout.
+    try:
+        write_osc52(sys.stderr.buffer, data)
+    except Exception as exc:  # noqa: BLE001 - single top-level error path
+        _eprint(str(exc))
+        return 1
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

osc52-0.1.0/tests/test_osc52.py

@@ -0,0 +1,42 @@
+"""Tests for osc52 core logic."""
+
+import base64
+import io
+
+from osc52.cli import MAX_PAYLOAD, OSC_END, OSC_START, write_osc52
+
+
+def test_basic_sequence():
+    buf = io.BytesIO()
+    write_osc52(buf, b"hello")
+    expected = OSC_START + base64.standard_b64encode(b"hello") + OSC_END
+    assert buf.getvalue() == expected
+
+
+def test_chunking():
+    # Choose data whose base64 length exceeds MAX_PAYLOAD to force >1 chunk.
+    data = b"a" * MAX_PAYLOAD  # base64 grows ~4/3, guaranteeing multiple chunks
+    buf = io.BytesIO()
+    write_osc52(buf, data)
+    out = buf.getvalue()
+    assert out.count(OSC_START) >= 2
+    # Reassemble the base64 payloads and verify they decode back to data.
+    parts = out.split(OSC_START)[1:]
+    b64 = b"".join(p[: -len(OSC_END)] for p in parts)
+    assert base64.standard_b64decode(b64) == data
+
+
+def test_roundtrip_decode():
+    payload = b"the quick brown fox\n\x00\xff binary too"
+    buf = io.BytesIO()
+    write_osc52(buf, payload)
+    out = buf.getvalue()
+    b64 = out[len(OSC_START) : -len(OSC_END)]
+    assert base64.standard_b64decode(b64) == payload
+
+
+def test_empty_payload():
+    buf = io.BytesIO()
+    write_osc52(buf, b"")
+    # Empty input produces no sequence.
+    assert buf.getvalue() == b""