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-shell or pip 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, and run_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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ask_shell-0.10.2.tar.gz (35.3 kB view details)

Uploaded Jul 30, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

ask_shell-0.10.2-py3-none-any.whl (40.9 kB view details)

Uploaded Jul 30, 2026 Python 3

File details

Details for the file ask_shell-0.10.2.tar.gz.

File metadata

Download URL: ask_shell-0.10.2.tar.gz
Upload date: Jul 30, 2026
Size: 35.3 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ask_shell-0.10.2.tar.gz
Algorithm	Hash digest
SHA256	`5f33c515643296de391a2af85bde49bcceb1c2a9393ffc8f787d876d2292cbc9`
MD5	`ac5fa01e888a9f3b95c2059400d4f7da`
BLAKE2b-256	`43aea35c3b51423e3685f72631fdb6585dd6aca8e4bc7b99a0ea885964b8d8c4`

See more details on using hashes here.

Provenance

The following attestation bundles were made for ask_shell-0.10.2.tar.gz:

Publisher: release.yaml on EspenAlbert/ask-shell

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: ask_shell-0.10.2.tar.gz
- Subject digest: 5f33c515643296de391a2af85bde49bcceb1c2a9393ffc8f787d876d2292cbc9
- Sigstore transparency entry: 2289527025
- Sigstore integration time: Jul 30, 2026
Source repository:
- Permalink: EspenAlbert/ask-shell@c4be14ce1b5f423f21a230bcc900147161fb8ebe
- Branch / Tag: refs/tags/v0.10.2
- Owner: https://github.com/EspenAlbert
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yaml@c4be14ce1b5f423f21a230bcc900147161fb8ebe
- Trigger Event: push