inquirer-textual 0.4.0__tar.gz → 1.0.0__tar.gz

{inquirer_textual-0.4.0 → inquirer_textual-1.0.0}/.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
 
     - name: Python Semantic Release
       id: release
-      uses: relekang/python-semantic-release@v10.5.3
+      uses: relekang/python-semantic-release@v10.5.2
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         strict: true

{inquirer_textual-0.4.0 → inquirer_textual-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: inquirer-textual
-Version: 0.4.0
+Version: 1.0.0
 Summary: Inquirer based on Textual
 Project-URL: Changelog, https://github.com/robvanderleek/inquirer-textual/blob/master/CHANGELOG.md
 Project-URL: Documentation, https://robvanderleek.github.io/inquirer-textual/
@@ -9,9 +9,7 @@ Author-email: Rob van der Leek <robvanderleek@gmail.com>
 License-Expression: GPL-3.0-or-later
 License-File: LICENSE
 Requires-Python: <3.15,>=3.9
-Requires-Dist: textual>=7.1.0
-Provides-Extra: examples
-Requires-Dist: textual-slider>=0.2.0; extra == 'examples'
+Requires-Dist: textual>=6.7.1
 Description-Content-Type: text/markdown
 
 # Inquirer-Textual
@@ -38,20 +36,11 @@ Description-Content-Type: text/markdown
 
 All terminal programs start small. Some stay small, and some become incredibly
 big. The goal of this Python library is to make user input simple for small
-programs, while enabling a smooth transition to a comprehensive UI library as
+programs, but also support a smooth transition to a comprehensive UI library as
 your program grows.
 
 Read the [documentation here](https://robvanderleek.github.io/inquirer-textual/)
 
-## Installation
-
-Create and activate a virtual environment (for example with
-[uv](https://docs.astral.sh/uv/)), and then install this package:
-
-```shell
-pip install inquirer-textual
-```
-
 ## Development
 
 Add this library as an editable local dependency to another project using `uv`:
@@ -59,31 +48,3 @@ Add this library as an editable local dependency to another project using `uv`:
 ```shell
 uv add --editable <path-to-inquirer-textual>
 ```
-
-### Textual console
-
-1. Open the Textual Development Console:
-
-```shell
-uv run textual console
-```
-
-2. Run application in development mode:
-
-```shell
-uv run textual run --dev examples/prompt_pattern.py
-```
-
-### Static documentation
-
-Generating the static documentation:
-
-```shell
-uv run mkdocs build
-```
-
-Viewing the static documentation:
-
-```shell
-uv run mkdocs serve
-```

{inquirer_textual-0.4.0 → inquirer_textual-1.0.0}/README.md

@@ -22,20 +22,11 @@
 
 All terminal programs start small. Some stay small, and some become incredibly
 big. The goal of this Python library is to make user input simple for small
-programs, while enabling a smooth transition to a comprehensive UI library as
+programs, but also support a smooth transition to a comprehensive UI library as
 your program grows.
 
 Read the [documentation here](https://robvanderleek.github.io/inquirer-textual/)
 
-## Installation
-
-Create and activate a virtual environment (for example with
-[uv](https://docs.astral.sh/uv/)), and then install this package:
-
-```shell
-pip install inquirer-textual
-```
-
 ## Development
 
 Add this library as an editable local dependency to another project using `uv`:
@@ -43,31 +34,3 @@ Add this library as an editable local dependency to another project using `uv`:
 ```shell
 uv add --editable <path-to-inquirer-textual>
 ```
-
-### Textual console
-
-1. Open the Textual Development Console:
-
-```shell
-uv run textual console
-```
-
-2. Run application in development mode:
-
-```shell
-uv run textual run --dev examples/prompt_pattern.py
-```
-
-### Static documentation
-
-Generating the static documentation:
-
-```shell
-uv run mkdocs build
-```
-
-Viewing the static documentation:
-
-```shell
-uv run mkdocs serve
-```

inquirer_textual-1.0.0/docs/faq.md

@@ -0,0 +1,6 @@
+# Frequently Asked Questions
+
+## What are similar projects?
+
+- [InquirerPy](https://github.com/kazhala/InquirerPy)
+- [python-inquirer](https://github.com/magmax/python-inquirer) 

{inquirer_textual-0.4.0 → inquirer_textual-1.0.0}/docs/index.md

@@ -21,11 +21,11 @@
     </a>
 </div>
 
-## Introduction
+## About
 
 All terminal programs start small. Some stay small, and some become incredibly
 big. The goal of this Python library is to make user input simple for small
-programs, while enabling a smooth transition to a comprehensive UI library as
+programs, but also support a smooth transition to a comprehensive UI library as
 your program grows.
 
 This library is based on the sophisticated
@@ -47,15 +47,6 @@ With `uv` you can run the example out of the box:
 uv run --with inquirer-textual checkbox.py
 ```
 
-## Installation
-
-Create and activate a virtual environment (for example with
-[uv](https://docs.astral.sh/uv/)), and then install this package:
-
-```shell
-pip install inquirer-textual
-```
-
 ## Key features and design principles
 
 * **Keep simple things simple**: High-level prompts API for getting user input

{inquirer_textual-0.4.0 → inquirer_textual-1.0.0}/examples/prompt_checkbox.py

@@ -1,7 +1,8 @@
 from inquirer_textual import prompts
 
 if __name__ == '__main__':
-    result = prompts.checkbox("Planets:", choices=[
-        'Mercury', 'Venus', 'Earth', 'Mars', 'Jupiter', 'Saturn', 'Uranus', 'Neptune'
+    answer = prompts.checkbox("Planets:", choices=[
+        'Mercury', 'Venus', 'Earth', 'Mars', 'Jupiter', 'Saturn', 
+        'Uranus', 'Neptune'
     ])
-    print(result)
+    print(answer)

inquirer_textual-1.0.0/examples/prompt_multi.py

@@ -0,0 +1,18 @@
+from inquirer_textual import prompts
+from inquirer_textual.widgets.InquirerCheckbox import InquirerCheckbox
+from inquirer_textual.widgets.InquirerConfirm import InquirerConfirm
+from inquirer_textual.widgets.InquirerNumber import InquirerNumber
+from inquirer_textual.widgets.InquirerSecret import InquirerSecret
+from inquirer_textual.widgets.InquirerText import InquirerText
+from inquirer_textual.widgets.InquirerSelect import InquirerSelect
+
+if __name__ == '__main__':
+    text_widget = InquirerText('Name:')
+    password_widget = InquirerSecret('Password:')
+    number_widget = InquirerNumber('Memory:')
+    confirm_widget = InquirerConfirm('Proceed?')
+    select_widget = InquirerSelect('Planet?', ['Earth', 'Mars', 'Venus'], default='Mars')
+    checkbox_widget = InquirerCheckbox("People?", choices=['Alice', 'Bob', 'Charlie'])
+    answer = prompts.multi(
+        [text_widget, password_widget, number_widget, confirm_widget, select_widget, checkbox_widget])
+    print(answer)

inquirer_textual-0.4.0/examples/prompt_editor.py → inquirer_textual-1.0.0/examples/prompt_number.py

@@ -1,5 +1,5 @@
 from inquirer_textual import prompts
 
 if __name__ == '__main__':
-    answer = prompts.editor('Analysis report:')
+    answer = prompts.number(message='Memory:')
     print(answer)

{inquirer_textual-0.4.0 → inquirer_textual-1.0.0}/examples/prompt_secret.py

@@ -1,5 +1,5 @@
 from inquirer_textual import prompts
 
 if __name__ == '__main__':
-    result = prompts.secret('Password:')
-    print(result)
+    answer = prompts.secret('Password:')
+    print(answer)

inquirer_textual-1.0.0/examples/prompt_select.py

@@ -0,0 +1,6 @@
+from inquirer_textual import prompts
+
+if __name__ == '__main__':
+    answer = prompts.select('Planet:', ['Mercury', 'Venus', 'Earth', 'Mars', 
+        'Jupiter', 'Saturn', 'Uranus', 'Neptune'], mandatory=False)
+    print(answer)

{inquirer_textual-0.4.0 → inquirer_textual-1.0.0}/examples/prompt_text.py

@@ -1,5 +1,5 @@
 from inquirer_textual import prompts
 
 if __name__ == '__main__':
-    result = prompts.text('Name:')
-    print(result)
+    answer = prompts.text('Name:')
+    print(answer)

inquirer_textual-1.0.0/examples/shortcuts.py

@@ -0,0 +1,7 @@
+from inquirer_textual import prompts
+from inquirer_textual.common.Shortcut import Shortcut
+
+if __name__ == '__main__':
+    shortcuts = [Shortcut('escape', 'select')]
+    answer = prompts.text("Enter your name:", shortcuts)
+    print(f'Your answer: {answer}')

{inquirer_textual-0.4.0 → inquirer_textual-1.0.0}/inquirer_textual/InquirerApp.py

@@ -10,19 +10,22 @@ from textual.binding import Binding, BindingsMap
 from textual.widgets import Footer
 
 from inquirer_textual.common.InquirerHeader import InquirerHeader
-from inquirer_textual.common.InquirerResult import InquirerResult
+from inquirer_textual.common.Result import Result
 from inquirer_textual.common.Shortcut import Shortcut
-from inquirer_textual.common.defaults import DEFAULT_THEME
 from inquirer_textual.widgets.InquirerWidget import InquirerWidget
 
 T = TypeVar('T')
 
 
-class InquirerApp(App[InquirerResult[T]], inherit_bindings=False):  # type: ignore[call-arg]
+class InquirerApp(App[Result[T]], inherit_bindings=False):  # type: ignore[call-arg]
     CSS = """
+        App {
+            background: black;
+        }
         Screen {
             border-top: none;
             border-bottom: none;
+            background: transparent;
             height: auto;
         }
         """
@@ -32,21 +35,18 @@ class InquirerApp(App[InquirerResult[T]], inherit_bindings=False):  # type: igno
         Binding("ctrl+d", "quit", "Quit", show=False, priority=True)
     ]
 
-    def __init__(self, theme: str = 'inquirer-textual-default') -> None:
-        self._theme = theme
+    def __init__(self) -> None:
         self.widget: InquirerWidget | None = None
         self.shortcuts: list[Shortcut] | None = None
         self.header: str | list[str] | None = None
         self.show_footer: bool = False
-        self.result: InquirerResult[T] | None = None
+        self.result: Result[T] | None = None
         self.result_ready: Event | None = None
         self.inquiry_func: Callable[[InquirerApp[T]], None] | None = None
         self.inquiry_func_stop: bool = False
         super().__init__()
 
     def on_mount(self) -> None:
-        self.register_theme(DEFAULT_THEME)
-        self.theme = self._theme
         self._update_bindings()
         if self.inquiry_func:
             self.run_worker(self.inquiry_func_worker, thread=True)
@@ -63,24 +63,21 @@ class InquirerApp(App[InquirerResult[T]], inherit_bindings=False):  # type: igno
         if self.inquiry_func:
             self.inquiry_func(self)
 
-    async def action_shortcut(self, command: str):
+    def action_shortcut(self, command: str):
         value = self.widget.current_value() if self.widget else None
-        await self._handle_result(command, value)
+        self._handle_result(command, value)
 
     async def action_quit(self):
-        await self._handle_result('quit', None)
+        self._handle_result('quit', None)
 
-    async def on_inquirer_widget_submit(self, event: InquirerWidget.Submit) -> None:
-        await self._handle_result(event.command, event.value)
+    def on_inquirer_widget_submit(self, event: InquirerWidget.Submit) -> None:
+        self._handle_result(event.command, event.value)
 
-    async def _handle_result(self, command: str | None, value: Any | None):
+    def _handle_result(self, command: str | None, value: Any | None):
         if self.result_ready is not None:
-            self.result = InquirerResult(self.widget.name if self.widget else None, value,  # type: ignore[arg-type]
-                                         command)
+            self.result = Result(command, value) # type: ignore[arg-type]
             self.result_ready.set()
         else:
-            if self.widget:
-                await self.widget.set_selected_value(value)
             self.call_after_refresh(lambda: self._terminate(command, value))
 
     def _terminate(self, command: str | None = None, value: Any | None = None):
@@ -88,9 +85,9 @@ class InquirerApp(App[InquirerResult[T]], inherit_bindings=False):  # type: igno
         if self.result_ready:
             self.result_ready.set()
         if command is not None:
-            self.app.exit(InquirerResult(self.widget.name if self.widget else None, value, command))
+            self.app.exit(Result(command, value))
         else:
-            self.exit(InquirerResult(None, value, None))
+            self.exit(value)
 
     def compose(self) -> ComposeResult:
         if self.header is not None:
@@ -105,7 +102,7 @@ class InquirerApp(App[InquirerResult[T]], inherit_bindings=False):  # type: igno
         if self.widget:
             self.call_after_refresh(self.widget.focus)
 
-    def prompt(self, widget: InquirerWidget, shortcuts: list[Shortcut] | None = None) -> InquirerResult[T]:
+    def prompt(self, widget: InquirerWidget, shortcuts: list[Shortcut] | None = None) -> Result[T]:
         if shortcuts:
             self.shortcuts = shortcuts
             self.show_footer = True
@@ -138,7 +135,7 @@ class InquirerApp(App[InquirerResult[T]], inherit_bindings=False):  # type: igno
             auto_pilot: AutopilotCallbackType | None = None,
             loop: AbstractEventLoop | None = None,
             inquiry_func: Callable[[InquirerApp[T]], None] | None = None,
-    ) -> InquirerResult[T]:
+    ) -> Result[T]:
         if not self.inquiry_func:
             self.inquiry_func = inquiry_func
         return super().run(
@@ -153,6 +150,7 @@ class InquirerApp(App[InquirerResult[T]], inherit_bindings=False):  # type: igno
 
     def get_theme_variable_defaults(self) -> dict[str, str]:
         return {
-            'inquirer-textual-question-mark': self.current_theme.foreground or 'initial',
-            'inquirer-textual-input-color': self.current_theme.foreground or 'initial',
+            'select-question-mark': '#e5c07b',
+            'select-list-item-highlight-foreground': '#61afef',
+            'input-color': '#98c379'
         }

{inquirer_textual-0.4.0 → inquirer_textual-1.0.0}/inquirer_textual/common/Choice.py

@@ -7,6 +7,3 @@ class Choice:
     name: str
     data: Any = None
     command: str = 'select'
-
-    def __str__(self) -> str:
-        return self.name

inquirer_textual-1.0.0/inquirer_textual/common/ChoiceLabel.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from textual.widgets import Label
+
+from inquirer_textual.common.Choice import Choice
+
+
+class ChoiceLabel(Label):
+    def __init__(self, item: str | Choice):
+        super().__init__(f'  {item if isinstance(item, str) else item.name}')
+        self._text = item if isinstance(item, str) else item.name
+        self.item = item
+
+    def add_pointer(self):
+        self.update(f'\u276f {self._text}')
+
+    def remove_pointer(self):
+        self.update(f'  {self._text}')

inquirer_textual-0.4.0/inquirer_textual/common/Prompt.py → inquirer_textual-1.0.0/inquirer_textual/common/PromptMessage.py

@@ -4,9 +4,9 @@ from textual.widget import Widget
 from textual.widgets import Static, Label
 
 
-class Prompt(Widget):
+class PromptMessage(Widget):
     DEFAULT_CSS = """
-        Prompt {
+        PromptMessage {
             width: auto;
             height: auto;
         }
@@ -16,7 +16,7 @@ class Prompt(Widget):
         }
         #prompt-message-question-mark {
             width: auto;
-            color: $inquirer-textual-question-mark;
+            color: $select-question-mark;
         }
         """
 

inquirer_textual-1.0.0/inquirer_textual/common/Result.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import TypeVar, Generic
+
+T = TypeVar('T')
+
+
+@dataclass
+class Result(Generic[T]):
+    command: str | None
+    value: T
+
+    def __str__(self):
+        return str(self.value)

inquirer_textual-1.0.0/inquirer_textual/prompts.py

@@ -0,0 +1,76 @@
+from typing import Any, Iterable
+
+from textual.validation import Validator
+
+from inquirer_textual.InquirerApp import InquirerApp
+from inquirer_textual.common.Choice import Choice
+from inquirer_textual.common.Result import Result
+from inquirer_textual.common.Shortcut import Shortcut
+from inquirer_textual.widgets.InquirerCheckbox import InquirerCheckbox
+from inquirer_textual.widgets.InquirerConfirm import InquirerConfirm
+from inquirer_textual.widgets.InquirerMulti import InquirerMulti
+from inquirer_textual.widgets.InquirerNumber import InquirerNumber
+from inquirer_textual.widgets.InquirerSecret import InquirerSecret
+from inquirer_textual.widgets.InquirerSelect import InquirerSelect
+from inquirer_textual.widgets.InquirerText import InquirerText
+from inquirer_textual.widgets.InquirerWidget import InquirerWidget
+
+
+def text(message: str, shortcuts: list[Shortcut] | None = None,
+         validators: Validator | Iterable[Validator] | None = None) -> Result[str]:
+    app: InquirerApp[str] = InquirerApp()
+    app.widget = InquirerText(message, validators=validators)
+    app.shortcuts = shortcuts
+    app.show_footer = bool(shortcuts)
+    return app.run(inline=True)
+
+
+def secret(message: str, shortcuts: list[Shortcut] | None = None) -> Result[str]:
+    app: InquirerApp[str] = InquirerApp()
+    app.widget = InquirerSecret(message)
+    app.shortcuts = shortcuts
+    app.show_footer = bool(shortcuts)
+    return app.run(inline=True)
+
+
+def number(message: str, shortcuts: list[Shortcut] | None = None) -> Result[int]:
+    app: InquirerApp[int] = InquirerApp()
+    app.widget = InquirerNumber(message)
+    app.shortcuts = shortcuts
+    app.show_footer = bool(shortcuts)
+    return app.run(inline=True)
+
+
+def confirm(message: str, shortcuts: list[Shortcut] | None = None, default: bool = False, mandatory: bool = True) -> \
+        Result[bool]:
+    app: InquirerApp[bool] = InquirerApp()
+    app.widget = InquirerConfirm(message, default=default, mandatory=mandatory)
+    app.shortcuts = shortcuts
+    app.show_footer = bool(shortcuts)
+    return app.run(inline=True)
+
+
+def select(message: str, choices: list[str | Choice], shortcuts: list[Shortcut] | None = None,
+           default: str | Choice | None = None, mandatory: bool = True) -> Result[str | Choice]:
+    app: InquirerApp[str | Choice] = InquirerApp()
+    app.widget = InquirerSelect(message, choices, default, mandatory)
+    app.shortcuts = shortcuts
+    app.show_footer = bool(shortcuts)
+    return app.run(inline=True)
+
+
+def checkbox(message: str, choices: list[str | Choice], shortcuts: list[Shortcut] | None = None,
+             enabled: list[str | Choice] | None = None) -> Result[list[str | Choice]]:
+    app: InquirerApp[list[str | Choice]] = InquirerApp()
+    app.widget = InquirerCheckbox(message, choices, enabled)
+    app.shortcuts = shortcuts
+    app.show_footer = bool(shortcuts)
+    return app.run(inline=True)
+
+
+def multi(widgets: list[InquirerWidget], shortcuts: list[Shortcut] | None = None) -> Result[list[Any]]:
+    app: InquirerApp[list[Any]] = InquirerApp()
+    app.widget = InquirerMulti(widgets)
+    app.shortcuts = shortcuts
+    app.show_footer = bool(shortcuts)
+    return app.run(inline=True)

inquirer_textual-1.0.0/inquirer_textual/version.py

@@ -0,0 +1 @@
+version = "1.0.0"

{inquirer_textual-0.4.0 → inquirer_textual-1.0.0}/inquirer_textual/widgets/InquirerCheckbox.py

@@ -1,43 +1,46 @@
 from __future__ import annotations
 
 from textual.app import ComposeResult
-from textual.containers import VerticalGroup, HorizontalGroup
+from textual.containers import VerticalGroup
 from textual.widgets import ListItem, ListView
 from typing_extensions import Self
 
-from inquirer_textual.common.Answer import Answer
 from inquirer_textual.common.Choice import Choice
 from inquirer_textual.common.ChoiceCheckboxLabel import ChoiceCheckboxLabel
-from inquirer_textual.common.Prompt import Prompt
+from inquirer_textual.common.PromptMessage import PromptMessage
 from inquirer_textual.widgets.InquirerWidget import InquirerWidget
 
 
 class InquirerCheckbox(InquirerWidget):
     """A checkbox widget that allows multiple selections from a list of choices."""
 
+    DEFAULT_CSS = """
+            #inquirer-checkbox-list-view {
+                background: transparent;
+            }
+            #inquirer-checkbox-list-view ListItem.-highlight {
+                color: $select-list-item-highlight-foreground;
+                background: transparent;
+            }
+            """
     BINDINGS = [
         ("space", "toggle_selected", "Toggle selection"),
     ]
 
-    def __init__(self, message: str, choices: list[str | Choice], name: str | None = None,
-                 enabled: list[str | Choice] | None = None, mandatory: bool = False):
+    def __init__(self, message: str, choices: list[str | Choice], enabled: list[str | Choice] | None = None):
         """
             Args:
                 message (str): The prompt message to display.
                 choices (list[str | Choice]): A list of choices to present to the user.
-                name (str | None): The name of the input field.
                 enabled (list[str | Choice] | None): A list of choices that should be pre-selected.
-                mandatory (bool): Whether at least one selection is mandatory.
         """
-        super().__init__(name=name, mandatory=mandatory)
+        super().__init__()
         self.message = message
         self.choices = choices
         self.enabled = enabled
         self.list_view: ListView | None = None
         self.selected_label: ChoiceCheckboxLabel | None = None
         self.selected_item: str | Choice | None = None
-        self.selected_value: list[str | Choice] | None = None
-        self.show_selected_value: bool = False
 
     def on_mount(self):
         self.styles.height = min(10, len(self.choices) + 1)
@@ -52,7 +55,7 @@ class InquirerCheckbox(InquirerWidget):
         self.selected_item = label.item
 
     def on_list_view_selected(self, _: ListView.Selected) -> None:
-        self.submit_current_value()
+        self.post_message(InquirerWidget.Submit(self.current_value()))
 
     def focus(self, scroll_visible: bool = True) -> Self:
         if self.list_view:
@@ -64,23 +67,12 @@ class InquirerCheckbox(InquirerWidget):
         labels = self.query(ChoiceCheckboxLabel)
         return [label.item for label in labels if label.checked]
 
-    async def set_selected_value(self, value: list[str | Choice]) -> None:
-        self.selected_value = value
-        self.styles.height = 1
-        self.show_selected_value = True
-        await self.recompose()
-
     def compose(self) -> ComposeResult:
-        if self.show_selected_value:
-            with HorizontalGroup():
-                yield Prompt(self.message)
-                yield Answer(str(self.selected_value))
-        else:
-            with VerticalGroup():
-                items: list[ListItem] = []
-                for idx, choice in enumerate(self.choices):
-                    list_item = ListItem(ChoiceCheckboxLabel(choice))
-                    items.append(list_item)
-                self.list_view = ListView(*items, id='inquirer-checkbox-list-view')
-                yield Prompt(self.message)
-                yield self.list_view
+        with VerticalGroup():
+            items: list[ListItem] = []
+            for idx, choice in enumerate(self.choices):
+                list_item = ListItem(ChoiceCheckboxLabel(choice))
+                items.append(list_item)
+            self.list_view = ListView(*items, id='inquirer-checkbox-list-view')
+            yield PromptMessage(self.message)
+            yield self.list_view