poetry is a required package to develop.

$ git clone
$ cd libtmux
$ poetry install -E "docs test coverage lint"

Makefile commands prefixed with watch_ will watch files and rerun.


poetry run py.test

Helpers: make test Rerun tests on file change: make watch_test (requires entr(1))

Pytest plugin

See also

See tmux pytest plugin.


Default preview server: http://localhost:8023

sphinx-autobuild will automatically build the docs, watch for file changes and launch a server.

From home directory: make start_docs From inside docs/: make start

Manual documentation (the hard way)

cd docs/ and make html to build. make serve to start http server.

Helpers: make build_docs, make serve_docs

Rebuild docs on file change: make watch_docs (requires entr(1))

Rebuild docs and run server via one terminal: make dev_docs (requires above, and a make(1) with -J support, e.g. GNU Make)



The project uses ruff to handle formatting, sorting imports and linting.


$ poetry run ruff

If you setup manually:

$ ruff .
$ make ruff
$ make watch_ruff

requires entr(1).


$ poetry run ruff . --fix

If you setup manually:

$ ruff . --fix

ruff format

ruff format is used for formatting.


$ poetry run ruff format .

If you setup manually:

$ ruff format .
$ make ruff_format


mypy is used for static type checking.


$ poetry run mypy .

If you setup manually:

$ mypy .
$ make mypy
$ make watch_mypy

requires entr(1).


Since this software is used by tens of thousands of users daily, we don’t want to release breaking changes. Additionally this is packaged on large Linux/BSD distros, so we must be mindful of architectural changes.

Choose what the next version is. Assuming it’s version 0.9.0, it could be:

  • 0.9.0post0: postrelease, if there was a packaging issue

  • 0.9.1: bugfix / security / tweak

  • 0.10.0: breaking changes, new features

Let’s assume we pick 0.9.1

CHANGES: Assure any PRs merged since last release are mentioned. Give a thank you to the contributor. Set the header with the new version and the date. Leave the “current” header and Insert changes/features/fixes for next release here at the top::

- *Insert changes/features/fixes for next release here*

libtmux 0.9.1 (2020-10-12)
- :issue:`1`: Fix bug

libtmux/ and - Set version

$ git commit -m 'Tag v0.9.1'
$ git tag v0.9.1

After git push and git push --tags, CI will automatically build and deploy to PyPI.

Releasing with Poetry (manual)

This isn’t used yet since package maintainers may want in the source. See

As of 0.10, poetry handles virtualenv creation, package requirements, versioning, building, and publishing. Therefore there is no or requirements files.

Update __version__ in and pyproject.toml::

git commit -m 'build(libtmux): Tag v0.1.1'
git tag v0.1.1
git push
git push --tags
poetry build
poetry deploy