feat/docs: remove keyboard.write

- This is removed because it is very reliant on the current selected keyboard layout. For example, writing `@` may work fine on the US keyboard layout but not on the UK keyboard layout
winstxnhdw · Jul 3, 2024 · eef3e80 · eef3e80
1 parent 81357fa
commit eef3e80
Show file tree

Hide file tree

Showing 7 changed files with 1 addition and 382 deletions.
diff --git a/README.md b/README.md
@@ -47,16 +47,6 @@ keyboard.press(0x0D)
 keyboard.press(0x5B, 0x44)
 ```
 
-#### String Inputs
-
-`KeyWin` can also convert strings to key codes, albeit at a slight performance cost.
-
-```python
-from keywin import keyboard
-
-keyboard.write('Hello World!')
-```
-
 ### Mouse
 
 Similar to the keyboard, `KeyWin` provides a low-level API for mouse inputs based on Microsoft's [MOUSEINPUT](https://learn.microsoft.com/en-us/windows/win32/api/winuser/ns-winuser-mouseinput) structure.

diff --git a/keywin/keyboard/__init__.py b/keywin/keyboard/__init__.py
@@ -1,4 +1,3 @@
-from keywin.keyboard.utils import convert_to_key_code
 from keywin.send_input import press_keyboard
 
 
@@ -17,20 +16,3 @@ def press(*keys: int) -> bool:
     success (bool) : the success of the event
     """
     return press_keyboard(keys)
-
-
-def write(string: str) -> list[bool]:
-    """
-    Summary
-    -------
-    high-level function to type a string
-
-    Parameters
-    ----------
-    string (str) : string to type
-
-    Returns
-    -------
-    successes (list[bool]) : the success of the event(s)
-    """
-    return [press(*key_codes) for key_codes in convert_to_key_code(string)]
diff --git a/keywin/keyboard/codes/__init__.py b/keywin/keyboard/codes/__init__.py
diff --git a/keywin/keyboard/exceptions/__init__.py b/keywin/keyboard/exceptions/__init__.py
diff --git a/keywin/keyboard/utils/__init__.py b/keywin/keyboard/utils/__init__.py
diff --git a/keywin/keyboard/utils/convert_to_key_code.py b/keywin/keyboard/utils/convert_to_key_code.py