Hyprpy

Hyprpy is a library which provides python bindings for the Hyprland window compositor. With Hyprpy, you can retrieve information about windows, workspaces and monitors in realtime and react to Hyprland events dynamically using pure Python.

Hyprpy communicates with Hyprland using unix sockets, making it fast and efficient. It also provides a versatile and resource-friendly signalling interface. With it, you can write python callbacks for Hyprland events.

Attention

Check out the guide for a demonstration of Hyprpy.

Getting started

To get started, install Hyprpy:

pip install hyprpy

and follow along with the guide, or dive straight into the extensive API reference if you’re feeling adventurous!

• Components Guide
  • The Instance
  • Reading component data
  • Accessing related components
  • Reacting to events
  • Component state
  • Further reading
• Components API
  • Instance
  • Window
  • Workspace
  • Monitor
  • Misc.
• Utilities API
  • Signals
  • Sockets
  • Shell
  • Assertions
• Data Models
  • Data model classes
  • Data model background
  • Component Data validators

Indices and tables

• Index

• Module Index

• Search Page