The [Wayfire] compositor provides access to its functionalities via Inter-Process Communication (IPC). This repository contains the source code for the python client bindings, as well as hosts many examples of how to use the IPC.

Quickstart

Installation

Python
pip install wayfire

AUR
yay -S python-wayfire

OR

git clone https://github.com/WayfireWM/pywayfire
cd pywayfire
python3 -m pip install .

Configure wayfire.ini

Activate following plugins. stipc only needed when wayfire.extra.stipc is used.

[core]
plugins = \
  ipc \
  ipc-rules \
  stipc
  ...

Usage examples

Basic usage is simple, import the wayfire.ipc module, create a socket (it will auto-detect the compositor by using the WAYFIRE_SOCKET environment variable) and call its functions:

from wayfire import WayfireSocket

socket = WayfireSocket()
print(socket.list_views())

Many examples can be found in the scripts directory.

Troubleshooting

"Failed to find a suitable Wayfire socket!"

Make sure ipc and ip-rules plugins are activated. Try running with environmental variable: WAYFIRE_SOCKET=/run/user/$(id -u)/wayland-1