tmux-wrapper 0.1.0__tar.gz

tmux_wrapper-0.1.0/LICENSE

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

tmux_wrapper-0.1.0/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: tmux-wrapper
+Version: 0.1.0
+Summary: Lightweight tmux automation wrapper and renderer.
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Randomizez/TmuxWrapper
+Project-URL: Repository, https://github.com/Randomizez/TmuxWrapper
+Project-URL: Issues, https://github.com/Randomizez/TmuxWrapper/issues
+Keywords: tmux,terminal,automation,cli
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Terminals
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fire>=0.7.1
+Dynamic: license-file
+
+# tmux-wrapper
+
+`tmux-wrapper` is a small Python module and CLI for driving a tmux session like
+a human: type text, press key chords, inspect what changed, and scroll through
+history.
+
+It is designed for agent workflows, test automation, and other cases where you
+want a simple tmux control surface instead of shelling out to a large stack of
+custom tmux commands.
+
+## Features
+
+- `type(text)` sends literal text to the active pane.
+- `press(chords)` sends key chords such as `Enter`, `Ctrl+C`, or `Ctrl+B Z`.
+- `snapshot()` captures the full current screen and resets the diff baseline.
+- `view()` is the recommended inspection API. It returns a contextual,
+  line-oriented delta against the previous capture.
+- `glance()` returns incremental additions plus collapsed
+  `...[N unchanged lines]` markers for unchanged regions.
+- `scroll_up(lines=3)` and `scroll_down(lines=3)` emulate mouse-wheel style
+  scrolling via tmux copy mode.
+- `tmux-c` provides the same workflow from the command line.
+
+## Requirements
+
+- Python 3.9+
+- `tmux` installed and available on `PATH`
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install tmux-wrapper
+```
+
+After installation, the CLI command `tmux-c` is available:
+
+```bash
+tmux-c 1 glance
+```
+
+## Quick Start
+
+### Python API
+
+```python
+from tmux_wrapper import Keys, TMUXWrapper
+
+tmux = TMUXWrapper(session="demo")
+
+# Establish a baseline for future view()/glance() calls.
+tmux.snapshot()
+
+tmux.type("echo hello")
+tmux.press([(Keys.Enter,)])
+print(tmux.view())
+
+# For a compact "only what was newly added" report:
+print(tmux.glance())
+
+tmux.scroll_up(5)
+print(tmux.view())
+
+tmux.scroll_down(999)
+tmux.delete()
+```
+
+### CLI
+
+```bash
+tmux-c demo snapshot
+tmux-c demo type "ls /data"
+tmux-c demo press Enter
+tmux-c demo view
+tmux-c demo glance
+tmux-c demo scroll_up 5
+tmux-c demo view
+tmux-c demo scroll_down 999
+```
+
+## How Inspection Works
+
+`view()` is the default inspection method.
+
+- `snapshot()` captures the full screen and stores it as the new baseline.
+- `view()` compares the current screen against the previous capture.
+- `glance()` uses the same diff basis, but returns only added lines plus
+  `...[N unchanged lines]` markers for unchanged regions.
+- Added lines are marked with `!!`.
+- Removed lines are hidden.
+- `?` helper lines from `difflib.ndiff` are also hidden.
+- If there are no new additions, `glance()` returns `[Nothing Changed]`.
+
+Example:
+
+```text
+!!new output line
+  existing prompt context
+```
+
+For compact incremental output, `glance()` returns abbreviated output such as:
+
+```text
+...[12 unchanged lines]
+!!new output line
+...[3 unchanged lines]
+```
+
+## Press Syntax
+
+In Python, `press()` accepts a list of chords:
+
+```python
+tmux.press([(Keys.Enter,)])
+tmux.press([(Keys.Ctrl, Keys.C)])
+tmux.press([(Keys.Ctrl, Keys.B), (Keys.Z,)])
+tmux.press([(Keys.Ctrl, Keys.B), (Keys.Left,)])
+```
+
+In the CLI, each chord is passed as an argument:
+
+```bash
+tmux-c demo press Enter
+tmux-c demo press Ctrl+C
+tmux-c demo press Ctrl+B Z
+tmux-c demo press Ctrl+B Left
+```
+
+## Scrolling
+
+`scroll_up()` and `scroll_down()` are line-based helpers built on tmux copy
+mode.
+
+- `scroll_up(lines)` enters copy mode and scrolls up by `lines`.
+- `scroll_down(lines)` scrolls down by `lines`.
+- When `scroll_down()` reaches the bottom, it exits copy mode automatically.
+
+This matches the intended "mouse wheel with `set -g mouse on`" feel more closely
+than page-based movement.
+
+## Session Behavior
+
+- `TMUXWrapper(session="name")` creates the session if it does not already
+  exist.
+- If the wrapper created the session, object cleanup will delete it by default.
+- Calling `delete()` always deletes the session immediately.
+- CLI snapshot/view/glance state is persisted per session so repeated
+  `tmux-c ...` calls can diff across separate invocations.
+
+## Development
+
+Install development dependencies with uv:
+
+```bash
+uv sync --dev
+```
+
+Run tests:
+
+```bash
+env -u VIRTUAL_ENV uv run pytest -q
+```
+
+## Notes
+
+- The package focuses on a practical tmux-driving workflow, not a full tmux
+  abstraction layer.
+- The renderer captures the full tmux window, not just a single pane.
+- The cursor is rendered visibly in full-screen snapshots.

tmux_wrapper-0.1.0/README.md

@@ -0,0 +1,170 @@
+# tmux-wrapper
+
+`tmux-wrapper` is a small Python module and CLI for driving a tmux session like
+a human: type text, press key chords, inspect what changed, and scroll through
+history.
+
+It is designed for agent workflows, test automation, and other cases where you
+want a simple tmux control surface instead of shelling out to a large stack of
+custom tmux commands.
+
+## Features
+
+- `type(text)` sends literal text to the active pane.
+- `press(chords)` sends key chords such as `Enter`, `Ctrl+C`, or `Ctrl+B Z`.
+- `snapshot()` captures the full current screen and resets the diff baseline.
+- `view()` is the recommended inspection API. It returns a contextual,
+  line-oriented delta against the previous capture.
+- `glance()` returns incremental additions plus collapsed
+  `...[N unchanged lines]` markers for unchanged regions.
+- `scroll_up(lines=3)` and `scroll_down(lines=3)` emulate mouse-wheel style
+  scrolling via tmux copy mode.
+- `tmux-c` provides the same workflow from the command line.
+
+## Requirements
+
+- Python 3.9+
+- `tmux` installed and available on `PATH`
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install tmux-wrapper
+```
+
+After installation, the CLI command `tmux-c` is available:
+
+```bash
+tmux-c 1 glance
+```
+
+## Quick Start
+
+### Python API
+
+```python
+from tmux_wrapper import Keys, TMUXWrapper
+
+tmux = TMUXWrapper(session="demo")
+
+# Establish a baseline for future view()/glance() calls.
+tmux.snapshot()
+
+tmux.type("echo hello")
+tmux.press([(Keys.Enter,)])
+print(tmux.view())
+
+# For a compact "only what was newly added" report:
+print(tmux.glance())
+
+tmux.scroll_up(5)
+print(tmux.view())
+
+tmux.scroll_down(999)
+tmux.delete()
+```
+
+### CLI
+
+```bash
+tmux-c demo snapshot
+tmux-c demo type "ls /data"
+tmux-c demo press Enter
+tmux-c demo view
+tmux-c demo glance
+tmux-c demo scroll_up 5
+tmux-c demo view
+tmux-c demo scroll_down 999
+```
+
+## How Inspection Works
+
+`view()` is the default inspection method.
+
+- `snapshot()` captures the full screen and stores it as the new baseline.
+- `view()` compares the current screen against the previous capture.
+- `glance()` uses the same diff basis, but returns only added lines plus
+  `...[N unchanged lines]` markers for unchanged regions.
+- Added lines are marked with `!!`.
+- Removed lines are hidden.
+- `?` helper lines from `difflib.ndiff` are also hidden.
+- If there are no new additions, `glance()` returns `[Nothing Changed]`.
+
+Example:
+
+```text
+!!new output line
+  existing prompt context
+```
+
+For compact incremental output, `glance()` returns abbreviated output such as:
+
+```text
+...[12 unchanged lines]
+!!new output line
+...[3 unchanged lines]
+```
+
+## Press Syntax
+
+In Python, `press()` accepts a list of chords:
+
+```python
+tmux.press([(Keys.Enter,)])
+tmux.press([(Keys.Ctrl, Keys.C)])
+tmux.press([(Keys.Ctrl, Keys.B), (Keys.Z,)])
+tmux.press([(Keys.Ctrl, Keys.B), (Keys.Left,)])
+```
+
+In the CLI, each chord is passed as an argument:
+
+```bash
+tmux-c demo press Enter
+tmux-c demo press Ctrl+C
+tmux-c demo press Ctrl+B Z
+tmux-c demo press Ctrl+B Left
+```
+
+## Scrolling
+
+`scroll_up()` and `scroll_down()` are line-based helpers built on tmux copy
+mode.
+
+- `scroll_up(lines)` enters copy mode and scrolls up by `lines`.
+- `scroll_down(lines)` scrolls down by `lines`.
+- When `scroll_down()` reaches the bottom, it exits copy mode automatically.
+
+This matches the intended "mouse wheel with `set -g mouse on`" feel more closely
+than page-based movement.
+
+## Session Behavior
+
+- `TMUXWrapper(session="name")` creates the session if it does not already
+  exist.
+- If the wrapper created the session, object cleanup will delete it by default.
+- Calling `delete()` always deletes the session immediately.
+- CLI snapshot/view/glance state is persisted per session so repeated
+  `tmux-c ...` calls can diff across separate invocations.
+
+## Development
+
+Install development dependencies with uv:
+
+```bash
+uv sync --dev
+```
+
+Run tests:
+
+```bash
+env -u VIRTUAL_ENV uv run pytest -q
+```
+
+## Notes
+
+- The package focuses on a practical tmux-driving workflow, not a full tmux
+  abstraction layer.
+- The renderer captures the full tmux window, not just a single pane.
+- The cursor is rendered visibly in full-screen snapshots.

tmux_wrapper-0.1.0/pyproject.toml

@@ -0,0 +1,46 @@
+[project]
+name = "tmux-wrapper"
+version = "0.1.0"
+description = "Lightweight tmux automation wrapper and renderer."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = ["tmux", "terminal", "automation", "cli"]
+classifiers = [
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Terminals",
+]
+dependencies = [
+    "fire>=0.7.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/Randomizez/TmuxWrapper"
+Repository = "https://github.com/Randomizez/TmuxWrapper"
+Issues = "https://github.com/Randomizez/TmuxWrapper/issues"
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project.scripts]
+tmux-c = "tmux_wrapper:main"
+
+[tool.setuptools]
+py-modules = ["tmux_wrapper"]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.4.2",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

tmux_wrapper-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+