ghosttpy 0.1.1__tar.gz

ghosttpy-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uvx ruff check src/ tests/
+      - run: uvx ruff format --check src/ tests/
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv run pytest -m "not integration" -v

ghosttpy-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+
+      - name: Verify version matches tag
+        run: |
+          TAG=${GITHUB_REF#refs/tags/v}
+          PKG_VERSION=$(python3 -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          if [ "$TAG" != "$PKG_VERSION" ]; then
+            echo "::error::Tag v$TAG does not match package version $PKG_VERSION"
+            exit 1
+          fi
+
+      - run: uv build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: read
+      attestations: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: actions/attest-build-provenance@v2
+        with:
+          subject-path: "dist/*"
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

ghosttpy-0.1.1/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

ghosttpy-0.1.1/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.2
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

ghosttpy-0.1.1/.python-version

@@ -0,0 +1 @@
+3.13

ghosttpy-0.1.1/LICENSE

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

ghosttpy-0.1.1/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.4
+Name: ghosttpy
+Version: 0.1.1
+Summary: A Python library for scripting Ghostty
+Project-URL: Homepage, https://github.com/DylanModesitt/ghosttpy
+Project-URL: Repository, https://github.com/DylanModesitt/ghosttpy
+Project-URL: Issues, https://github.com/DylanModesitt/ghosttpy/issues
+Author-email: Dylan Modesitt <dylanmodesitt@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# ghosttpy
+
+A Python interface for scripting [Ghostty](https://ghostty.org) on macOS via AppleScript.
+
+## Requirements
+
+- macOS
+- Python >= 3.13
+- [Ghostty](https://ghostty.org) >= 1.3.0 (when AppleScript support was introduced)
+
+## Install
+
+```
+pip install ghosttpy
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```
+uv add ghosttpy
+```
+
+## Quick start
+
+```python
+from ghosttpy import Ghostty
+
+g = Ghostty()
+w = g.new_window(working_directory="/tmp")
+term = w.selected_tab.focused_terminal
+term.input("echo hello\n")
+```
+
+Accessing `w.name` or `term.working_directory` queries Ghostty to read the current state.
+
+## Object model
+
+Ghostty's scripting hierarchy is `Ghostty` > `Window` > `Tab` > `Terminal`. Each object has a stable `id` and can be compared or used in sets.
+
+```python
+g = Ghostty()
+
+g.windows           # all open windows
+g.front_window      # the frontmost window
+g.name              # "Ghostty"
+g.version           # e.g. "1.3.1"
+g.frontmost         # True if Ghostty is the active app
+g.is_running        # True if the Ghostty process is running
+
+w = g.front_window
+w.tabs              # tabs in this window
+w.terminals         # all terminals across all tabs
+w.selected_tab      # the active tab
+
+tab = w.selected_tab
+tab.index           # 1-based position in the tab bar
+tab.selected        # True if this tab is active
+tab.focused_terminal
+tab.terminals       # terminals (split panes) in this tab
+
+term = tab.focused_terminal
+term.name
+term.working_directory
+```
+
+## Creating windows, tabs, and splits
+
+```python
+w = g.new_window()
+tab = w.new_tab()
+right = term.split("right")   # returns the new Terminal
+below = term.split("down")
+```
+
+Split directions are `"right"`, `"left"`, `"down"`, and `"up"` (or use the `SplitDirection` enum).
+
+Close any object with `.close()`. Bring a window to the front with `w.activate()`, select a tab with `tab.select()`, or focus a terminal with `term.focus()`.
+
+## Configuration
+
+Windows, tabs, and splits accept keyword arguments to configure the terminal surface:
+
+```python
+w = g.new_window(font_size=14.0, working_directory="/tmp")
+tab = w.new_tab(command="/bin/bash", environment={"EDITOR": "vim"})
+new_term = term.split("right", initial_input="ls\n", wait_after_command=True)
+```
+
+Available options: `font_size`, `working_directory`, `command`, `initial_input`, `wait_after_command`, `environment`.
+
+To reuse the same configuration across multiple calls, pass a `Surface` object:
+
+```python
+from ghosttpy import Surface
+
+cfg = Surface(font_size=14.0, working_directory="/tmp")
+w1 = g.new_window(config=cfg)
+w2 = g.new_window(config=cfg)
+```
+
+## Terminal input
+
+`input()` sends text as if pasted. `send_key()` sends individual key events.
+
+```python
+term.input("ls -la\n")
+term.send_key("c", modifiers="control")
+term.send_key("enter")
+term.send_key("a", modifiers=["control", "shift"], action="release")
+```
+
+`perform()` executes a [Ghostty action](https://ghostty.org/docs/config/keybind/reference) string and returns whether it succeeded:
+
+```python
+term.perform("copy_to_clipboard")
+term.perform("reset")
+```
+
+Mouse events are also available:
+
+```python
+term.send_mouse_position(x=100.0, y=200.0)
+term.send_mouse_button("left button")
+term.send_mouse_scroll(x=0, y=-3.0, precision=True)
+```
+
+## Window management
+
+Read or set a window's geometry:
+
+```python
+from ghosttpy import Bounds, Point, Size
+
+w.bounds                        # Bounds(left, top, right, bottom)
+w.bounds = Bounds(0, 0, 960, 540)
+
+w.position                      # Point(x, y)
+w.size                          # Size(width, height)
+
+w.move_to(100, 100)
+w.resize_to(800, 600)
+```
+
+### Tiling
+
+Tile a window into a predefined screen region with `ScreenRegion`:
+
+```python
+from ghosttpy import ScreenRegion
+
+w.tile(ScreenRegion.left_half)
+w.tile(ScreenRegion.top_right, gap=10)
+```
+
+Available regions:
+
+| Halves | Quarters | Thirds | Fourths | Sixths |
+|--------|----------|--------|---------|--------|
+| `left_half` | `top_left` | `left_third` | `first_fourth` | `first_sixth` |
+| `right_half` | `top_right` | `center_third` | `second_fourth` | `second_sixth` |
+| `top_half` | `bottom_left` | `right_third` | `third_fourth` | `third_sixth` |
+| `bottom_half` | `bottom_right` | `left_two_thirds` | `last_fourth` | `fourth_sixth` |
+| | | `right_two_thirds` | `left_three_fourths` | `fifth_sixth` |
+| | | | `right_three_fourths` | `last_sixth` |
+
+There is also `full`, which is equivalent to `maximize()`.
+
+### Maximize, center, and grid
+
+```python
+w.maximize()
+w.center()
+
+# Tile all windows in an auto-sized grid
+g.tile_windows()
+
+# Tile specific windows in a 3-column grid with gaps
+g.tile_windows([w1, w2, w3], columns=3, gap=10)
+```
+
+All layout methods accept an optional `screen` parameter. When omitted, they use the main display.
+
+## Screen geometry
+
+```python
+scr = g.main_screen()      # Screen for the primary display
+scr.origin                  # Point -- top-left corner of usable area
+scr.size                    # Size -- usable width and height (excludes menu bar and Dock)
+scr.bounds                  # Bounds -- computed from origin and size
+
+all_screens = g.screens()   # list[Screen] for every display
+```
+
+## Raw AppleScript
+
+For anything the library doesn't wrap, two escape hatches are available:
+
+```python
+# Runs inside `tell application "Ghostty" ... end tell`
+g.tell('get name of front window')
+
+# Runs raw AppleScript with no wrapping
+g.run('tell application "Finder" to get name of front window')
+```
+
+## Error handling
+
+Failed AppleScript calls raise `GhosttyError`, which includes the error message and an optional numeric `code`:
+
+```python
+from ghosttpy import GhosttyError
+
+try:
+    term.perform("nonexistent_action")
+except GhosttyError as e:
+    print(e, e.code)
+```
+
+## Enums
+
+String arguments like `"right"`, `"press"`, and `"left button"` are accepted everywhere, but typed enum alternatives are available if you prefer:
+
+- `SplitDirection` -- `right`, `left`, `down`, `up`
+- `InputAction` -- `press`, `release`
+- `MouseButton` -- `left`, `right`, `middle`
+- `ScrollMomentum` -- `none`, `began`, `changed`, `ended`, `cancelled`, `may_begin`, `stationary`