{"id":18478952,"url":"https://github.com/wayfirewm/pywayfire","last_synced_at":"2025-08-11T16:11:25.450Z","repository":{"id":250706428,"uuid":"821355484","full_name":"WayfireWM/pywayfire","owner":"WayfireWM","description":"Python bindings for Wayfire's IPC","archived":false,"fork":false,"pushed_at":"2025-03-25T20:50:58.000Z","size":337,"stargazers_count":11,"open_issues_count":0,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-07T09:40:00.238Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WayfireWM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-28T11:00:59.000Z","updated_at":"2025-03-30T08:50:05.000Z","dependencies_parsed_at":"2024-09-05T16:57:31.722Z","dependency_job_id":"3d95d6b9-df17-42fe-a58e-5dd1bf99e6b1","html_url":"https://github.com/WayfireWM/pywayfire","commit_stats":null,"previous_names":["wayfirewm/pywayfire"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WayfireWM%2Fpywayfire","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WayfireWM%2Fpywayfire/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WayfireWM%2Fpywayfire/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WayfireWM%2Fpywayfire/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WayfireWM","download_url":"https://codeload.github.com/WayfireWM/pywayfire/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247871830,"owners_count":21010115,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T12:12:43.520Z","updated_at":"2025-04-08T15:33:44.301Z","avatar_url":"https://github.com/WayfireWM.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"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.\n\n## Quickstart\n\n### Installation\n```\nPython\npip install wayfire\n\nAUR\nyay -S python-wayfire\n```\n\nOR\n\n```\ngit clone https://github.com/WayfireWM/pywayfire\ncd pywayfire\npython3 -m pip install .\n```\n\n### Configure wayfire.ini\n\nActivate following plugins. `stipc` only needed when `wayfire.extra.stipc` is used. \n```ini\n[core]\nplugins = \\\n  ipc \\\n  ipc-rules \\\n  stipc\n  ...\n```\n\n### Usage examples\n\nBasic 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:\n\n```py\nfrom wayfire import WayfireSocket\n\nsocket = WayfireSocket()\nprint(socket.list_views())\n```\n\nMany examples can be found in the `scripts` directory.\n\n## Troubleshooting\n\n**\"Failed to find a suitable Wayfire socket!\"**\n\nMake sure `ipc` and `ip-rules` plugins are activated. Try running with environmental variable:\n`WAYFIRE_SOCKET=/run/user/$(id -u)/wayland-1`\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwayfirewm%2Fpywayfire","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwayfirewm%2Fpywayfire","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwayfirewm%2Fpywayfire/lists"}