Python — libtmux

Python

Drive a real tmux from Python.

libtmux

Install

$ pip install libtmux

Quickstart

import libtmux

server = libtmux.Server()
session = server.new_session(session_name="demo")
session.active_pane.send_keys("echo hello from libtmux")

The shape follows the README's Server() opening; new_session, active_pane and send_keys are verified against src/libtmux/server.py, session.py and pane.py, not quoted verbatim from one block.

API References

Official reference

Every public Python symbol, extracted from source on libtmux.org and cross-linked to the other seven ports.

Upstream reference

Python's own documentation, rendered with gp-sphinx — a different document from the reference extracted here.

Read on

Topics

Deep dives into one subject at a time, in Python: architecture, traversal, options and hooks.

Guides

Task-oriented walkthroughs in Python — install tmux, then the round trip every real program starts from.

Examples

The same concrete tasks worked through in Python, with each snippet checked by the port's own tests.

Concepts

The domain model every port shares — the object hierarchy, transports and filtering.