dworshak-prompt 0.2.24

Multiplexed user input via console, GUI, and web, depending on availability.

'# dworshak-prompt

A Python utility that ensures you can always get user input by falling back through multiple interfaces.

How it works

It captures input by cycling through modes based on environment availability:

1. Console (CLI)
2. GUI (Tkinter)
3. Web (Local Browser Server)

Automatically skips incompatible modes (e.g., GUI on WSL) via pyhabitat.

Usage

Obtain

Leverage dworshak-config, dworshak-config, and dworshak-env to automatically handle values.

from dworshak_prompt import DworshakObtain

DworshakObtain().config(service, item, message)
DworshakObtain().secret(service, item, message)
DworshakObtain().env(key, message)

Ask

Prompt the user then handle values manually.

from dworshak_prompt import DworshakPrompt, PromptMode

# Basic
val = DworshakPrompt().ask("Enter value")

# Options
val = DworshakPrompt().ask(
    message = "Secure Key",
    hide_input=True,
    priority = [PromptMode.CONSOLE, PromptMode.GUI]
    avoid = {PromptMode.WEB}

)

Another example, for handling CI:

from dworshak_prompt import DworshakPrompt, PromptMode

# If this runs in GitHub Actions, it returns "staging" immediately.
# If it runs on a laptop, it pops up a GUI or Console prompt.
val = DworshakPrompt().ask(
    message = "Target Environment",
    suggestion="production",  # What the human sees
    default="staging"         # What the CI/Headless system uses
)

Leveraging dworshak-prompt for calling and adding configured values.

from dworshak_prompt import DworshakObtain

# Custom path for a specific project
obtain_mgr = DworshakObtain(config_path="~/.pipeline-eds/config.json")
api_key = obtain_mgr.config("api_key", message="Enter EDS API Key")

The default config file path is "~/.dworshak/config.json".

---

CLI

The dworshak layer is the intended primary CLI entry point, but the dworshak-prompt CLI can be used directly.

pipx install "dworshak-prompt[typer]"
dworshak-prompt --version
dworshak-prompt --help
dworshak-prompt ask --message "Please state name" --interace web

See the dworshak-prompt Typer CLI structure.

dworshak-prompt helptree

helptree is utility funtion for Typer CLIs, imported from the typer-helptree library.

• GitHub: https://github.com/City-of-Memphis-Wastewater/typer-helptree
• PyPI: https://pypi.org/project/typer-helptree/

---

Add dworshak-prompt to Python project

When using uv for dependency management.

uv add dworshak-prompt --extra typer

Or, when using raw pip for dependency management.

pip install "dworshak-prompt[typer]"

Including the typer optional dependency group ensures that Typer and Rich are included as a dependencies. Without this, the CLI and console_prompt functionality are still stable, due to Python standard library fallbacks.

---

More Information

• User Stories

---

Sister Projects in the Dworshak Ecosystem

• CLI/Orchestrator: dworshak
• Interactive UI: dworshak-prompt
• Secrets Storage: dworshak-secret
• Plaintext Pathed Configs: dworshak-config
• Classic .env Injection: dworshak-env

pipx install dworshak
pip install dworshak-secret
pip install dworshak-config
pip install dworshak-env
pip install dworshak-prompt