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 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
# for a venv: python3 -m venv .venv && . .venv/bin/activate
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
Release files for wayfire 4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| wayfire-4.0.tar.gz | 24.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| wayfire-4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 50.0 kB
Release files / wayfire-4.0.tar.gz
| Download URL | wayfire-4.0.tar.gz |
|---|---|
| Size | 24.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6cdeba83f02be73864772436381f344beb0c254c9fbb9464dd9ec64dc10f8741
|
|
BLAKE2b-256 checksum How to use checksums |
4114ee32a4cf36b3f1a9bc567a9e232fc4fa1457ce6ecb2990046fc7bc4b12ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 27, 2026.
Transparency logRelease files / wayfire-4.0-py3-none-any.whl
| Download URL | wayfire-4.0-py3-none-any.whl |
|---|---|
| Size | 25.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4994a5dc5dc3be3a2fcfbaa8e51dd706f0742f56d6ee812336c8e456d70e238e
|
|
BLAKE2b-256 checksum How to use checksums |
798e2912a9fa75774213618aec779a3f9d221e856d0d63194cc29f251e4b3295
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 27, 2026.
Transparency log
