make-selection 0.0.1__py3-none-any.whl

make_selection/__init__.py

@@ -0,0 +1 @@
+from .make_selection import makeSelection

make_selection/make_selection.py

@@ -0,0 +1,140 @@
+"""
+Module for interactive command line menu. Simply accepts a list of str-able objects
+and allows user to select using arrow keys.
+"""
+import sys
+if sys.platform != "win32":
+    raise NotImplementedError("This module is only available on Windows.")
+from typing import Any
+import msvcrt
+import ctypes
+
+stdout = -11
+enable_ansi_codes = 7
+kernel32 = ctypes.windll.kernel32
+kernel32.SetConsoleMode(kernel32.GetStdHandle(stdout), enable_ansi_codes)
+
+ANSI_MOVE_CURSOR = "\x1b[{up}F\r\x1b[{right}C"
+ANSI_HIGHLIGHT   = "\x1b[30;47m"
+ANSI_YELLOW      = "\x1b[93m"
+ANSI_BLUE        = "\x1b[94m"
+ANSI_RESET       = "\x1b[0m"
+SPECIAL_KEY = 224
+UP_ARROW    = 72
+DOWN_ARROW  = 80
+ENTER_KEY   = 13
+CTL_C       = 3
+BACKSPACE   = 8
+SPACEBAR    = 32
+
+class Menu:
+    def __init__(self, options: list, label: str, window_size: int=10) -> None:
+        assert options
+        assert label
+        assert 1 < window_size
+        if len(options) < window_size:
+            window_size = len(options)
+
+        self.options_original = options
+        self.options_current = options
+        self.indices = []
+        self.search_string = ""
+        self.label = label
+        self.selected_index = 0
+        self.window_top = 0
+        self.window_original_size = window_size
+        self.window_current_size = window_size
+        self.help_string = "Enter: Select, Ctl+C: Cancel"
+
+    def show(self):
+        print(f"{ANSI_BLUE}{self.label}>{ANSI_RESET}")
+        self.printMenu()
+        while True:
+            something_changed = False
+            char = self.getChar()
+            if char == SPECIAL_KEY:
+                char = self.getChar()
+                if 1 < len(self.options_current):
+                    # Update selected index
+                    if char == UP_ARROW:
+                        self.selected_index = (self.selected_index - 1) % len(self.options_current)
+                        something_changed = True
+                    elif char == DOWN_ARROW:
+                        self.selected_index = (self.selected_index + 1) % len(self.options_current)
+                        something_changed = True
+                
+                    # Update window
+                    if something_changed:
+                        bottom = self.window_top + self.window_current_size
+                        if self.selected_index < self.window_top:
+                            self.window_top = self.selected_index
+                        elif bottom <= self.selected_index:
+                            self.window_top = self.selected_index - self.window_current_size + 1
+            elif self.isAscii(char) or (char == SPACEBAR and 0 < len(self.search_string)):
+                # TODO: search string
+                pass
+            elif char == BACKSPACE and 0 < len(self.search_string):
+                # TODO: search string
+                pass
+            elif char == ENTER_KEY:
+                if self.options_current:
+                    self.printSelected()
+                    return self.options_original[self.selected_index]
+            elif char == CTL_C:
+                self.clearMenu(clear_label=True)
+                print("cancelled")
+                return None
+
+            if something_changed:
+                self.clearMenu()
+                self.printMenu()
+
+    def getChar(self):
+        return ord(msvcrt.getch())
+
+    def isAscii(self, char):
+        return (33 <= char and char <= 126)
+    
+    def clearMenu(self, clear_label=False):
+        if clear_label:
+            print("\x1b[0G\x1b[J", end="", flush=True)
+        else:
+            print("\x1b[J")
+
+    def printMenu(self):
+        bottom = self.window_top + self.window_current_size
+        for i in range(self.window_top, bottom):
+            if i == self.selected_index:
+                print(f"{ANSI_HIGHLIGHT}{self.options_current[i]}{ANSI_RESET}")
+            else:
+                print(self.options_current[i])
+        print(f"{ANSI_YELLOW}{self.help_string}{ANSI_RESET}\n{ANSI_MOVE_CURSOR.format(up=self.window_current_size + 2, right=len(self.label) + len(self.search_string) + 1)}", end="", flush=True)
+
+    def printSelected(self):
+        self.clearMenu(clear_label=True)
+        print(f"{self.label}> {self.options_current[self.selected_index]}")
+
+def makeSelection(options: list[Any], label: str, window_size: int=None) -> Any:
+    """
+    Entry point for menu selection.
+
+    Parameters
+    ----------
+    options
+        List of str-able objects.
+    label
+        Label to describe the items being selected.
+    window_size
+        Max number of items to show at once.
+
+    Returns
+    -------
+    Selected value.
+    """
+    if window_size:
+       return Menu(options, label, window_size).show()
+    else:
+       return Menu(options, label).show()
+
+if __name__ == "__main__":
+    makeSelection(["interactive", "cli", "menu"], "make_selection")

make_selection-0.0.1.dist-info/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Steve Frazee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

make_selection-0.0.1.dist-info/METADATA

@@ -0,0 +1,39 @@
+Metadata-Version: 2.1
+Name: make_selection
+Version: 0.0.1
+Summary: Package for interactive command line menu
+Author-email: Steven Frazee <stevefrazee123@gmail.com>
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+<p align="center">
+  <img src="https://github.com/steve3424/make_selection/blob/main/images/logo.png?raw=true" alt="Make selection logo">
+</p>
+
+
+## Setup
+```
+pip install make_selection
+```
+
+## Example
+#### file.py
+```python
+from make_selection import makeSelection
+
+options = ["one", "two", "three"]
+label = "choose option"
+selected = makeSelection(options, label)
+```
+
+#### Interacting with menu
+<img src="https://github.com/steve3424/make_selection/blob/main/images/using_menu.png?raw=true" alt="image of cli while using the menu">
+<br>
+
+#### After making selection
+<img src="https://github.com/steve3424/make_selection/blob/main/images/item_selected.png?raw=true" alt="image of cli after item is selected">

make_selection-0.0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+make_selection/__init__.py,sha256=NtV-iIr0EcWNHj3KCF1Y09fwkhS6pLnnIDFjSceNq2w,41
+make_selection/make_selection.py,sha256=MMILn0nJrIMbFE0HRhuBZQRvRQwt1dOKM0bM9Xb9Iq8,4839
+make_selection-0.0.1.dist-info/LICENSE,sha256=LFtv4AT1hdd5yEJmN2r5KjtjmI3p0iMiz0R1JF-fVxg,1055
+make_selection-0.0.1.dist-info/METADATA,sha256=epoPQnAoippZWqoVA6rVRfVylwqRBtKTZzTZrd4D1TY,1196
+make_selection-0.0.1.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+make_selection-0.0.1.dist-info/top_level.txt,sha256=md_80U2NNa3Ni6gFbctLsZ8jE4hqSgu_HdMul1gTEgg,15
+make_selection-0.0.1.dist-info/RECORD,,

make_selection-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (73.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

make_selection-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+make_selection