ask-shell
Python library for CLIs that use interactive prompts, subprocess runs with Rich output, and test helpers so the same flows run in tests without a TTY.
- Install:
uv add ask-shellorpip install ask-shell(Python 3.13+) - Docs: GitHub Pages
What it provides
- ask: Prompts (confirm, text, select list/dict, single and multiple choice) built on questionary, with Rich styling
- shell: Run shell commands via
run,run_and_wait, andrun_pool; prefixed live output, optional log dirs, retries, and interrupt handling - console: Rich console and progress utilities;
configure_logging(app)wires a Typer app to Rich logging (handler, command decorator, optional secret hiding) - shell_events: Callbacks for run lifecycle (before/after, stdout/stderr) for custom handling
- AskShellSettings: Paths and options (e.g. run log directory); plug into your config or env
Quick example
from ask_shell import ask, shell
if ask.confirm("Run the script?", default=True):
name = ask.text("Name:", default="world")
shell.run_and_wait(f"echo Hello, {name}")
Testing
Use question_patcher to feed fixed responses to prompts, or raise_on_question to fail fast when a prompt is hit. Both are context managers; see the ask API docs for details.
from ask_shell import ask
from ask_shell.ask import question_patcher
with question_patcher(responses=["y", "myname"]):
assert ask.confirm("Run?")
assert ask.text("Name:") == "myname"
License
MIT. See LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for ask-shell 0.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ask_shell-0.11.0.tar.gz | 39.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ask_shell-0.11.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 84.7 kB
Release files / ask_shell-0.11.0.tar.gz
| Download URL | ask_shell-0.11.0.tar.gz |
|---|---|
| Size | 39.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9e89189888a3389d611d5fac3efbcc37fc88941b392a86b7bafac3e1b36c570c
|
|
BLAKE2b-256 checksum How to use checksums |
343725b59bd9f373e67e920d73f004dec2e9214cceab4f910f6f8f2ef6429edb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 3, 2026.
Transparency logRelease files / ask_shell-0.11.0-py3-none-any.whl
| Download URL | ask_shell-0.11.0-py3-none-any.whl |
|---|---|
| Size | 45.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dc86e353fd1d5390c704396c3e79ac5d7df4188ca77788eead93553052ea2d65
|
|
BLAKE2b-256 checksum How to use checksums |
cbf9a915e9c39e95ef2ed21cc1a24b8d77d23f53755858d6edc2f4b6fb84b33a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 3, 2026.
Transparency log
