niripy 0.2.7

Python bindings for Niri.

Niripy

Python bindings for the Niri wayland compositor.

Quickstart

Installation

Python Package Index

Install with any of the following depending on your python package manager:

pip install niripy
poetry add niripy
uv add niripy

Arch Linux

The package is also available on the AUR:

yay -S python-niripy

Examples

from niripy import Instance

niri = Instance()

window = niri.get_active_window()

Development

[!WARNING] Initial Development Niripy is still in very active and early stages of development.

Please file an issue if you find any bugs or have a feature request.

Credit to hyprpy for providing inspiration and a great starting point.

Roadmap

• Add AUR package
• Add flake.nix
• Generate documentation site with Material for MkDocs
• Second socket for listening to event-stream
• Instance.watch method for events

Nix

This repository provides a nix flake for development.

nix develop
python --version
python -c "import pydantic; print(pydantic.__version__)"
python -c "import niripy"