keybinds 1.3.2__tar.gz → 1.3.3__tar.gz

{keybinds-1.3.2 → keybinds-1.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: keybinds
-Version: 1.3.2
+Version: 1.3.3
 Summary: Flexible global keyboard & mouse hotkeys for Windows
 Author: echolane
 License: MIT License
@@ -55,7 +55,7 @@ Flexible global keyboard & mouse hotkeys for Windows.
 ![Python](https://img.shields.io/badge/python-3.7%2B-blue)
 ![Platform](https://img.shields.io/badge/platform-windows-lightgrey)
 ![License](https://img.shields.io/badge/license-MIT-green)
-![Status](https://img.shields.io/badge/status-active-success)
+![Status](https://img.shields.io/badge/status-maintenance-yellow)
 ![PyPI](https://img.shields.io/pypi/v/keybinds)
 
 **keybinds** is a Python library for global keyboard and mouse binds on Windows, with support for hotkeys, logical key binds, text matching, and text abbreviations.
@@ -194,17 +194,25 @@ Top-level helpers use the default hook. If you use multiple hooks, prefer `hook.
 
 ## Bind state and waiting
 
-All bind objects expose two small runtime helpers:
+All bind objects expose small runtime helpers:
 
 ```python
 if bind.is_pressed():
-    print("bind is currently active")
+    print("full chord is currently held")
+
+if bind.any_pressed():
+    print("at least one key/button of this bind is held")
+
+print(bind.pressed_keys())  # held VKs for this bind, or [button] for mouse
 
 bind.wait()          # wait until the bind fires
 bind.wait(0.5)       # wait up to 0.5s, returns True/False
 ```
 
-`is_pressed()` checks whether the bind is currently pressed.
+`is_pressed()` is true only when the current chord step is fully held (same `ChordPolicy` / `InjectedPolicy` rules as matching).
+`any_pressed()` is true if any key or button belonging to that step is held.
+`pressed_keys()` returns those held keys: sorted VK codes for keyboard/logical binds, or `[button]` / `[]` for mouse.
+Text-sequence and abbreviation binds: `any_pressed()` follows buffer/pending match; `pressed_keys()` returns `[]`.
 `wait(timeout=None)` blocks until the bind fires and returns `True`, or returns `False` on timeout.
 
 ---