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

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: inquirer-textual
-Version: 0.2.0
+Version: 0.4.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,7 +9,9 @@ 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>=6.7.1
+Requires-Dist: textual>=7.1.0
+Provides-Extra: examples
+Requires-Dist: textual-slider>=0.2.0; extra == 'examples'
 Description-Content-Type: text/markdown
 
 # Inquirer-Textual
@@ -36,11 +38,20 @@ 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, but also support a smooth transition to a comprehensive UI library as
+programs, while enabling 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`:
@@ -48,3 +59,31 @@ 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.2.0 → inquirer_textual-0.4.0}/README.md

@@ -22,11 +22,20 @@
 
 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, but also support a smooth transition to a comprehensive UI library as
+programs, while enabling 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`:
@@ -34,3 +43,31 @@ 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/docs/examples/prompts/editor.md

@@ -0,0 +1,11 @@
+# Editor
+
+An input widget that uses an external editor.
+
+## Example
+
+![Example](editor.gif)
+
+```python
+--8<-- "examples/prompt_editor.py"
+```

inquirer_textual-0.4.0/docs/examples/prompts/editor.tape

@@ -0,0 +1,17 @@
+Output docs/examples/prompts/editor.gif
+Set Shell zsh
+Set Theme { "background": "#000000" }
+Type "uv run examples/prompt_editor.py"
+Enter
+Sleep 2s
+Enter
+Sleep 2s
+Escape
+Sleep 1s
+Type "iHello world!"
+Sleep 2s
+Escape
+Sleep 1s
+Type ":wq"
+Enter
+Sleep 3s

inquirer_textual-0.4.0/docs/examples/prompts/external.md

@@ -0,0 +1,12 @@
+# External
+
+Embed external widgets in a prompt, for example a slider from
+[TomJGooding/textual-slider](https://github.com/TomJGooding/textual-slider).
+
+## Example
+
+![Example](external.gif)
+
+```python
+--8<-- "examples/prompt_external.py"
+```

inquirer_textual-0.4.0/docs/examples/prompts/external.tape

@@ -0,0 +1,24 @@
+Output docs/examples/prompts/external.gif
+Set Shell zsh
+Set Theme { "background": "#000000" }
+Type "uv run examples/prompt_external.py"
+Enter
+Sleep 2s
+Right
+Sleep 0.1s
+Right
+Sleep 0.1s
+Right
+Sleep 0.1s
+Right
+Sleep 0.1s
+Right
+Sleep 0.1s
+Right
+Sleep 0.1s
+Right
+Sleep 0.1s
+Right
+Sleep 1s
+Enter
+Sleep 3s

inquirer_textual-0.4.0/docs/examples/prompts/path.md

@@ -0,0 +1,11 @@
+# Path
+
+An input prompt that allows the user to enter a file path.
+
+## Example
+
+![Example](path.gif)
+
+```python
+--8<-- "examples/prompt_path.py"
+```

inquirer_textual-0.4.0/docs/examples/prompts/path.tape

@@ -0,0 +1,10 @@
+Output docs/examples/prompts/path.gif
+Set Shell zsh
+Set Theme { "background": "#000000" }
+Type "uv run examples/prompt_path.py"
+Enter
+Sleep 2s
+Type "/var/log"
+Sleep 1s
+Enter
+Sleep 3s

inquirer_textual-0.4.0/docs/examples/prompts/pattern.md

@@ -0,0 +1,12 @@
+# Pattern
+
+A select widget that allows a single selection from a list of choices with
+pattern filtering.
+
+## Example
+
+![Example](pattern.gif)
+
+```python
+--8<-- "examples/prompt_pattern.py"
+```

inquirer_textual-0.4.0/docs/examples/prompts/pattern.tape

@@ -0,0 +1,12 @@
+Output docs/examples/prompts/pattern.gif
+Set Shell zsh
+Set Theme { "background": "#000000" }
+Type "uv run examples/prompt_pattern.py"
+Enter
+Sleep 2s
+Type "on"
+Sleep 2s
+Down
+Sleep 2s
+Enter
+Sleep 3s

inquirer_textual-0.4.0/docs/faq.md

@@ -0,0 +1,11 @@
+# Frequently Asked Questions
+
+## Q. How does Inquirer-Textual compare to ...
+
+**[InquirerPy](https://github.com/kazhala/InquirerPy)**
+
+**[python-inquirer](https://github.com/magmax/python-inquirer)**
+
+**[Inquirer.js](https://github.com/SBoudrias/Inquirer.js)**
+
+The OG of Inquirer libraries, written in TypeScript.

inquirer_textual-0.4.0/docs/getting-started/index.md

@@ -0,0 +1,39 @@
+# Getting Started
+
+## Install
+
+The first step is to install Inquirer-Textual.
+
+Inside a virtual environemnt, this library can be installed with:
+
+```shell
+pip install inquirer-textual
+```
+
+## Simple text prompt
+
+The prompt API is very straightforward, for example to get a text input:
+
+```python
+--8<-- "docs/getting-started/simple_text_prompt.py"
+```
+
+![Simple text prompt](simple_text_prompt.gif)
+
+## Multiple prompts
+
+By calling the prompt API multiple times, a form-like inquiry can be done:
+
+```python
+--8<-- "docs/getting-started/simple_text_prompts.py"
+```
+
+![Simple text prompts](simple_text_prompts.gif)
+
+It's also possible to use a single multi prompt:
+
+```python
+--8<-- "docs/getting-started/simple_multi_prompt.py"
+```
+
+![Simple multi prompt](simple_multi_prompt.gif)

inquirer_textual-0.4.0/docs/getting-started/simple_multi_prompt.py

@@ -0,0 +1,9 @@
+from inquirer_textual import prompts
+from inquirer_textual.widgets.InquirerText import InquirerText
+
+if __name__ == "__main__":
+    answers = first_name = prompts.multi({
+        'first_name': InquirerText('First name:'),
+        'last_name': InquirerText('Last name:')
+    })
+    print(f'Hello, {answers["first_name"]} {answers["last_name"]}! 👋')

inquirer_textual-0.4.0/docs/getting-started/simple_multi_prompt.tape

@@ -0,0 +1,14 @@
+Output docs/getting-started/simple_multi_prompt.gif
+Set Shell zsh
+Set Theme { "background": "#000000" }
+Type "uv run docs/getting-started/simple_multi_prompt.py"
+Enter
+Sleep 2s
+Type Charlie
+Sleep 1s
+Enter
+Sleep 2s
+Type Brown
+Sleep 1s
+Enter
+Sleep 3s

inquirer_textual-0.4.0/docs/getting-started/simple_text_prompt.py

@@ -0,0 +1,5 @@
+from inquirer_textual import prompts
+
+if __name__ == "__main__":
+    name = prompts.text('Enter your name:')
+    print(f'Hello, {name}! 👋')

inquirer_textual-0.4.0/docs/getting-started/simple_text_prompt.tape

@@ -0,0 +1,10 @@
+Output docs/getting-started/simple_text_prompt.gif
+Set Shell zsh
+Set Theme { "background": "#000000" }
+Type "uv run docs/getting-started/simple_text_prompt.py"
+Enter
+Sleep 2s
+Type Rob
+Sleep 1s
+Enter
+Sleep 3s

inquirer_textual-0.4.0/docs/getting-started/simple_text_prompts.py

@@ -0,0 +1,6 @@
+from inquirer_textual import prompts
+
+if __name__ == "__main__":
+    first_name = prompts.text('First name:')
+    last_name = prompts.text('Last name:')
+    print(f'Hello, {first_name} {last_name}! 👋')

inquirer_textual-0.4.0/docs/getting-started/simple_text_prompts.tape

@@ -0,0 +1,14 @@
+Output docs/getting-started/simple_text_prompts.gif
+Set Shell zsh
+Set Theme { "background": "#000000" }
+Type "uv run docs/getting-started/simple_text_prompts.py"
+Enter
+Sleep 2s
+Type Charlie
+Sleep 1s
+Enter
+Sleep 2s
+Type Brown
+Sleep 1s
+Enter
+Sleep 3s

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

@@ -21,11 +21,11 @@
     </a>
 </div>
 
-## About
+## Introduction
 
 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, but also support a smooth transition to a comprehensive UI library as
+programs, while enabling a smooth transition to a comprehensive UI library as
 your program grows.
 
 This library is based on the sophisticated
@@ -47,6 +47,15 @@ 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/docs/reference/editor.md

@@ -0,0 +1,3 @@
+# InquirerEditor
+
+::: inquirer_textual.widgets.InquirerEditor.InquirerEditor

inquirer_textual-0.4.0/docs/reference/path.md

@@ -0,0 +1,3 @@
+# InquirerPath
+
+::: inquirer_textual.widgets.InquirerPath.InquirerPath

inquirer_textual-0.4.0/docs/reference/pattern.md

@@ -0,0 +1,3 @@
+# InquirerPattern
+
+::: inquirer_textual.widgets.InquirerPattern.InquirerPattern

inquirer_textual-0.4.0/docs/themes/catppuccin_mocha.tape

@@ -0,0 +1,27 @@
+Output docs/themes/catppuccin_mocha.gif
+Set Shell zsh
+Set Theme { "background": "#000000" }
+Type "uv run examples/themes.py catppuccin-mocha"
+Enter
+Sleep 2s
+Type y
+Sleep 1s
+Type "555-2368"
+Enter
+Sleep 1s
+Enter
+Sleep 1s
+Type "3"
+Enter
+Sleep 1s
+Space
+Down
+Sleep 1s
+Space
+Sleep 1s
+Enter
+Sleep 1s
+Enter
+Sleep 1s
+Enter
+Sleep 3s

inquirer_textual-0.4.0/docs/themes/index.md

@@ -0,0 +1,18 @@
+# Themes
+
+## textual-dark
+
+![textual-dark](textual_dark.gif)
+
+## textual-light
+
+![textual-light](textual_light.gif)
+
+## nord
+
+![nord](nord.gif)
+
+## solarized-light
+
+![solarized-light](solarized_light.gif)
+

inquirer_textual-0.4.0/docs/themes/nord.tape

@@ -0,0 +1,27 @@
+Output docs/themes/nord.gif
+Set Shell zsh
+Set Theme { "background": "#000000" }
+Type "uv run examples/themes.py nord
+Enter
+Sleep 2s
+Type y
+Sleep 1s
+Type "555-2368"
+Enter
+Sleep 1s
+Enter
+Sleep 1s
+Type "3"
+Enter
+Sleep 1s
+Space
+Down
+Sleep 1s
+Space
+Sleep 1s
+Enter
+Sleep 1s
+Enter
+Sleep 1s
+Enter
+Sleep 3s

inquirer_textual-0.4.0/docs/themes/solarized_light.tape

@@ -0,0 +1,27 @@
+Output docs/themes/solarized_light.gif
+Set Shell zsh
+Set Theme { "background": "#000000" }
+Type "uv run examples/themes.py solarized-light"
+Enter
+Sleep 2s
+Type y
+Sleep 1s
+Type "555-2368"
+Enter
+Sleep 1s
+Enter
+Sleep 1s
+Type "3"
+Enter
+Sleep 1s
+Space
+Down
+Sleep 1s
+Space
+Sleep 1s
+Enter
+Sleep 1s
+Enter
+Sleep 1s
+Enter
+Sleep 3s

inquirer_textual-0.4.0/docs/themes/textual_dark.tape

@@ -0,0 +1,27 @@
+Output docs/themes/textual_dark.gif
+Set Shell zsh
+Set Theme { "background": "#000000" }
+Type "uv run examples/themes.py textual-dark"
+Enter
+Sleep 2s
+Type y
+Sleep 1s
+Type "555-2368"
+Enter
+Sleep 1s
+Enter
+Sleep 1s
+Type "3"
+Enter
+Sleep 1s
+Space
+Down
+Sleep 1s
+Space
+Sleep 1s
+Enter
+Sleep 1s
+Enter
+Sleep 1s
+Enter
+Sleep 3s

inquirer_textual-0.4.0/docs/themes/textual_light.tape

@@ -0,0 +1,27 @@
+Output docs/themes/textual_light.gif
+Set Shell zsh
+Set Theme { "background": "#000000" }
+Type "uv run examples/themes.py textual-light"
+Enter
+Sleep 2s
+Type y
+Sleep 1s
+Type "555-2368"
+Enter
+Sleep 1s
+Enter
+Sleep 1s
+Type "3"
+Enter
+Sleep 1s
+Space
+Down
+Sleep 1s
+Space
+Sleep 1s
+Enter
+Sleep 1s
+Enter
+Sleep 1s
+Enter
+Sleep 3s

inquirer_textual-0.4.0/examples/alternatives/inquirerpy/main.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env -S uv run --script
+#
+# https://inquirerpy.readthedocs.io/
+
+# /// script
+# dependencies = [
+#   "inquirerpy",
+# ]
+# ///
+
+from InquirerPy import inquirer
+from InquirerPy.validator import EmptyInputValidator
+
+def confirm():
+    return inquirer.confirm(message='Do you want to save this entry?').execute()
+
+def fuzzy():
+    return inquirer.fuzzy(
+        message="Select element:",
+        choices=["Hydrogen", "Helium", "Lithium", "Beryllium", "Boron", 
+            "Carbon"],
+        default="Lithium",
+    ).execute()
+
+def number():
+    return inquirer.number(
+        message="Enter integer:",
+        min_allowed=-2,
+        max_allowed=10,
+        validate=EmptyInputValidator(),
+    ).execute()
+
+if __name__ == "__main__":
+    print(fuzzy())