wayfire compositor library
Project description
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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file wayfire-3.2.tar.gz.
File metadata
- Download URL: wayfire-3.2.tar.gz
- Upload date:
- Size: 22.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dd8e2cfc0d39a4442edafe1557bedd2db04210400bf96d09c25c1aa051f53207
|
|
| MD5 |
e3b54ab09994619c554aa77da63f6c14
|
|
| BLAKE2b-256 |
393fce5e0ec2688e7b338b18deaca0b665158a613b0431c6be79162a0a698179
|
Provenance
The following attestation bundles were made for wayfire-3.2.tar.gz:
Publisher:
wayfire-package.yml on WayfireWM/pywayfire
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
wayfire-3.2.tar.gz -
Subject digest:
dd8e2cfc0d39a4442edafe1557bedd2db04210400bf96d09c25c1aa051f53207 - Sigstore transparency entry: 226967860
- Sigstore integration time:
-
Permalink:
WayfireWM/pywayfire@a0ae14da8269236489bdd78130b54a4781edb537 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/WayfireWM
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
wayfire-package.yml@a0ae14da8269236489bdd78130b54a4781edb537 -
Trigger Event:
push
-
Statement type:
File details
Details for the file wayfire-3.2-py3-none-any.whl.
File metadata
- Download URL: wayfire-3.2-py3-none-any.whl
- Upload date:
- Size: 22.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e7dc3ca3523738e1f1a388e11a20f045ec7a1762b3c3648eaaa3f6a319156065
|
|
| MD5 |
65973b10095f2d80261fb14eddba9c0f
|
|
| BLAKE2b-256 |
39cd771bbd3a36e7d6f75884711a22b4c072ac0ebc43ffb3ad4053e57ad160cc
|
Provenance
The following attestation bundles were made for wayfire-3.2-py3-none-any.whl:
Publisher:
wayfire-package.yml on WayfireWM/pywayfire
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
wayfire-3.2-py3-none-any.whl -
Subject digest:
e7dc3ca3523738e1f1a388e11a20f045ec7a1762b3c3648eaaa3f6a319156065 - Sigstore transparency entry: 226967861
- Sigstore integration time:
-
Permalink:
WayfireWM/pywayfire@a0ae14da8269236489bdd78130b54a4781edb537 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/WayfireWM
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
wayfire-package.yml@a0ae14da8269236489bdd78130b54a4781edb537 -
Trigger Event:
push
-
Statement type: