pupptyeer-client

Thin Python client for the pupptyeer daemon: NDJSON over a unix socket, standard library only (no dependencies).

pupptyeer is a local daemon that owns persistent PTY sessions. This client talks to it over the daemon's unix socket; it does not start the daemon. Install and run the daemon separately (see the main README), or npm i -g pupptyeer for the prebuilt binary.

Install

pip install pupptyeer-client

Requires Python >= 3.8.

Usage

import os, sys
from pupptyeer_client import PupptyeerClient

# Connect to the daemon's unix socket (the daemon exports its path via $PUPPTYEER_SOCK).
c = PupptyeerClient.connect(os.environ["PUPPTYEER_SOCK"])

# Spawn a command in a fresh PTY; get back a session id.
sid = c.new_session(command="bash", cols=80, rows=24)

# Stream the session's live output, then attach this connection.
c.on_output(sid, lambda b: sys.stdout.buffer.write(b))
c.attach(sid, cols=80, rows=24)

# Drive it.
c.write_pane(sid, "echo hello\n")

# Read the daemon's authoritative rendered screen once the PTY goes quiet.
screen = c.capture_screen(sid, settle_ms=50)
print("\n".join(screen.lines))

c.close()  # sessions outlive the client

See the protocol spec for the full verb set (new_session, list_sessions, attach/detach, write_pane, capture_pane, resize, kill, gc).

License

MIT

Development Status
- 4 - Beta
Intended Audience
- Developers
License
- OSI Approved :: MIT License
Operating System
- MacOS
- POSIX
Programming Language
- Python :: 3
Topic
- Software Development :: Libraries
- Terminals

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pupptyeer_client-0.9.0.tar.gz (6.7 kB view details)

Uploaded Jun 21, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

pupptyeer_client-0.9.0-py3-none-any.whl (7.0 kB view details)

Uploaded Jun 21, 2026 Python 3

File details

Details for the file pupptyeer_client-0.9.0.tar.gz.

File metadata

Download URL: pupptyeer_client-0.9.0.tar.gz
Upload date: Jun 21, 2026
Size: 6.7 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pupptyeer_client-0.9.0.tar.gz
Algorithm	Hash digest
SHA256	`2a98b0d9ae723008a0be7e8daf871d9cbba288b60e2d76212e4e986dda54e1c1`
MD5	`e3191776ea024c999c2f6fcf728629f1`
BLAKE2b-256	`220072913de5d5b1a17745f97ed7f0fd808ef7da885435c21897d7696afdc403`

See more details on using hashes here.

Provenance

The following attestation bundles were made for pupptyeer_client-0.9.0.tar.gz:

Publisher: release.yml on PeterSR/pupptyeer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: pupptyeer_client-0.9.0.tar.gz
- Subject digest: 2a98b0d9ae723008a0be7e8daf871d9cbba288b60e2d76212e4e986dda54e1c1
- Sigstore transparency entry: 1895287878
- Sigstore integration time: Jun 21, 2026
Source repository:
- Permalink: PeterSR/pupptyeer@15ad36c64f2e657220dcca241e2d9cf835c7f10c
- Branch / Tag: refs/tags/v0.9.0
- Owner: https://github.com/PeterSR
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@15ad36c64f2e657220dcca241e2d9cf835c7f10c
- Trigger Event: push