CHANGES

Changelog

To install the unreleased libtmux version, see developmental releases.

pip:

$ pip install --user --upgrade --pre libtmux

libtmux 0.12.x (unreleased)

• Insert changes/features/fixes for next release here

Development

• Remove tox and tox-poetry-installer

  This created issues with running poetry while inside the virtualenv.

Documentation

• Try out sphinx-autoapi for its table of contents generation ({issue}367)

Testing

• retry(): Add deprecation warning. This will be removed in 0.13.x ({issue}368, {issue}372)
• New function retry_until(): Polls a callback function for a set period of time until it returns True or times out. By default it will raise {exc}libtmux.exc.WaitTimeout, with raises=False it will return False. Thank you @categulario! ({issue}368, {issue}372)

libtmux 0.11.0 (2022-03-10)

Compatibility

• Final python 3.7 and 3.8 release

  Bug fixes and security updates will go to v0.11.x

• Internal: Use new separator to split tmux(1) formatting information ({issue}289, {issue}343)

  The separator is configurable via LIBTMUX_TMUX_FORMAT_SEPARATOR. If you ever have compatiblity issues in the future let us know which default works best across versions.

  Credit: @JonathanRaiman and @jagguli

• Basic type annotations ({issue}359, {issue}361) via @otherJL0

Development

• Code cleanup ({issue}362) from @otherJL0
• Format with black w/ string normalization. This is a one-time diff ({issue}354)

Documentation

• Sidebar reorganized into sections
• Added documentation on fetching developmental releases of libtmux

libtmux 0.10.3 (2022-01-10)

Packaging

First experimental release using poetry build ({issue}347). If you are packaging and run across any difficulty please see {issue}346.

Compatibility

• Drop python 3.6 ({issue}344)

• Add python 3.10, though still packaging.version issues remain ({issue}344)

  A compat module and version constraints will need to be added for this

Development

• poetry: 1.1.7 -> 1.1.12 ({issue}344)
• Add .pre-commit-config.yaml ({issue}344)

libtmux 0.10.2 (2021-10-30)

• {issue}324: Update poetry to 1.1

  • CI: Use poetry 1.1.7 and install-poetry.py installer
  • Relock poetry.lock at 1.1 (w/ 1.1.7's fix)

• {issue}339 (CI): Lock python at 3.9 to avoid poetry issue with dataclasses

• ci: Fix publishing docs (similar to {issue}339)

• {issue}341 {issue}342: Server.attached_sessions() now supports multiple attached sessions.

  Remove attached sessions limitation to not detect multiple attached clients, thank you @timoses

libtmux 0.10.1 (2021-06-16)

• Update Window.select_window() for {issue}271

libtmux 0.10.0 (2021-06-16)

• {issue}321: Convert to markdown
• {issue}271: Fix {}select_window() by providing the session ID as argument to {}-t. Thanks @Flowdalic
• Drop python 3.5 support

libtmux 0.9.0 (2021-06-14)

Python 2.7 support dropped.

• {issue}306: chore: Remove python 2.7 support
• {issue}314: chore: Python 3.x syntax tweaks
• {issue}312: ci: Add tmux 3.2a to CI
• chore: Update black to 21.6b0
• {issue}271: Fix select_window() by providing the session ID as argument to -t.

libtmux 0.8.5 (2020-10-25)

• {issue}297: Enchance subprocess interaction std[in|out|err]. Needed for interact with big buffer, fixes {issue}251, thank you @gil-obradors!
• {issue}303 Add common.get_libtmux_version which gives the tmux version as a loose constraint. Fix linking to terms inside docs, and duplicate description of module which sphinx warned about in api.rst.
• {issue}266 Fix issue on local tests where env variables would cause show-environment to pause tests indefinitely.

libtmux 0.8.4 (2020-10-25)

• {issue}234: Window.split_window: Allow passing percent, Thank you @jinankjain!
• {issue}289: Fix warning due to invalid escape sequences, Thank you @tirkarthi!
• {issue}295: Publish docs via our own action
• {issue}295: Move more packaging over to poetry, though we'll keep setup.py for the moment to ensure compatibility package maintainers.
• {issue}295: New development instructions
• {issue}295: Move doc/ to docs/
• {issue}296: CI: Test python 2.7, cache python packages, prevent running internal PRs twice

libtmux 0.8.3 (2020-08-16)

• {issue}278: Fix Python deprecation warnings, thanks @d1618033

  Also thanks Flowdalic for a similar PR at {issue}294

• Add project_urls to setup.py

• {issue}293 Move from Pipfile to poetry

• Fix show_option test in tmux 3.0

• Clean up handle_option_error comments

• Move CI to a GitHub action

libtmux 0.8.2 (2019-06-02)

• CHANGES updated to plain reStructuredText
• Add project_urls to setup.py for pypi.
• Looser Pipfile versions, add Pipfile.lock

libtmux 0.8.1 (2019-01-26)

• {issue}117 Fix issue with renaming clients with tmux 2.7 on BSD/macOS machines.
• {issue}121 Support literal=True (-l) in Pane.send_keys from @ritiek
• {issue}131 Fix for unicode commands in Python 2, thanks @myw
• {issue}172 Support for next-X.Y versions from @sloria
• {issue}120 capture_pane support for Pane
• {issue}119 display_message support for Pane
• Sort imports with isort
• Add sphinxcontrib-napoleon package for documentation
• Move docstrings over to numpy's style

libtmux 0.8.0 (2018-03-11)

• {issue}46 Change license from BSD to MIT
• Move to new organization, tmux-python
• Support package updates to pytest, sphinx, etc.
• Travis/CI: Limit tests to Python 2.7 and 3.6 (removed 3.3 to 3.5)
• Travis/CI: Update pypy veersions
• {issue}103 Server.new_session learned how to run commands in window on session start, thanks @grimpy!
• {issue}68 Make Server.has_session() use returncode, thanks @jlargentaye! This should make has_session more robust.

libtmux 0.7.8 (2018-03-04)

• Port retry function from tmuxp (tmux-python/tmuxp#354)

libtmux 0.7.7 (2017-11-10)

• Don't add -x/-y in tmux >= 2.6 if running tmuxp from inside client.

libtmux 0.7.6 (2017-11-09)

• Allow Window.select_layout with no args
• Fix test where bell- was no longer ambiguous as of tmux 2.6

libtmux 0.7.5 (2017-10-07)

• Hotfix to support tmux 2.6 session creation

libtmux 0.7.4 (2017-08-19)

• {issue}65 Add session id to commands, thanks @askedrelic

libtmux 0.7.3 (2017-05-29)

• Exact matches only supported on 2.1 and up

libtmux 0.7.2 (2017-05-29)

• Support exact matching in Server.has_session

libtmux 0.7.1 (2017-04-28)

• {issue}37 Improve support for formatted options like pane-border-status. Thanks @kaushalmodi.

libtmux 0.7.0 (2017-04-27)

• Support for python 2.6 dropped. New minimum version is 2.7

• Add support for tmux 2.4, pypy and pypy3

• Overhaul error handling when setting and showing options

  • Added {}handle_option_error for handling option errors
  • Added {exc}libtmux.exc.OptionError base exception
  • Added {exc}libtmux.exc.InvalidOption and {}libtmux.exc.AmbiguousOption
  • {exc}libtmux.exc.UnknownOption now extends {exc}libtmux.exc.OptionError

• Overhaul version checking

  • has_version has been renamed to get_version
  • get_version will return tmux built from git master as the latest version supported by the libtmux version with -master at the end, e.g. 2.4-master
  • get_version will return tmux on openbsd base system as the latest version supported by the libtmux version with -openbsd at the end, e.g. 2.4-openbsd
  • has_required_tmux_version has been renamed to has_minimum_version
  • added has_gt_version, has_gte_version, has_lt_version, has_lte_version,

• Fixed up documentation in some session methods

• Added pydoc exception info to option methods in window and sessions.

• Added TMUX_MIN_VERSION and TMUX_MAX_VERSION

libtmux 0.6.5 (2017-04-02)

• Fix which command
• Add TmuxCommandNotFound exception
• Add tmux_search_paths and append_env_path kwargs to tmux_cmd.

libtmux 0.6.4 (2017-03-25)

• {issue}32 support for OpenBSD's tmux

libtmux 0.6.3 (2017-02-08)

• {issue}25 support for working with tmux master, thanks @sloria.

libtmux 0.6.2 (2017-01-19)

• {issue}197 use {}LooseVersion instead of {}StrictVersion for version checks. Thanks @minijackson.
• Pin packages with pyup.io
• {issue}21 Readme fix from @huwenchao.

libtmux 0.6.1 (2016-12-20)

• {issue}18 Fix logger, courtesy of @geekli
• {issue}19 Add support for start_directory in new sessions and panes, courtesy of @gandelman-a.
• Fix tests and add official support for 2.3

libtmux 0.6.0 (2016-09-16)

• Raise exception for invalid session names. tmux does not allow names that are empty, contain periods or colons.
• Remove unused target_sesssion param in Server.attach_session and Server.switch_client.

libtmux 0.5.1 (2016-08-18)

• {issue}12 - fix logger message when tmux doesn't exist in PATH

libtmux 0.5 (2016-06-15)

• {issue}8 new exception UnknownOption
• {issue}8 return None for options that are valid tmux options, but unset at that scope.
• {issue}6 major documentation overhaul

libtmux 0.4.1 (2016-05-23)

• update which() to find tmux via os.environ['PATH']. https://redd.it/4laeut

libtmux 0.4.0 (2016-05-23)

• attributes for formatters are now accessible via Session, Window and Pane objects. session.name is equivalent to session.get('session_name'), you can do the same with other properties in _info. window.name, pane.current_path, session.id, window.id, pane.id, session.index, window.index, pane.index, etc.
• attached_sessions, attached_window and attached_pane are now properties.
• _TMUX metadata object changed to _info.
• .findWhere() is now find_where.
• README and usage fixes

libtmux 0.3.0 (2016-05-23)

• switch to pytest

libtmux 0.1.0 (2016-05-22)

• libtmux forked from tmuxp.