timed-prompt 0.0.3

Cross-platform input/getpass prompt with real timeout (Windows/Linux/macOS)

timed-prompt

---

A cross-platform Python library for input() / getpass() prompts with a real timeout, compatible with Windows, Linux, and macOS.

Unlike the standard input(), this library ensures:

• Timeout is enforced safely
• No daemon threads or signals required
• Works reliably on Windows console
• Simple SSH-style password prompt UX

---

✨ Features

• ✔ Cross-platform: Windows / Linux / macOS
• ✔ Works with both input() and getpass()
• ✔ Enforces timeout without hanging or crashing
• ✔ Optional quiet mode (no prompt output)
• ✔ Can be used in CLI tools, scripts, and SSH-style workflows

---

🔹 Project layout

timed-prompt/
├── timed_prompt/          # Importable package
│   ├── __init__.py        # Exposes API
│   └── prompt.py          # Core logic
├── examples/              # Non-package demo scripts
│   └── demo.py
├── .github/
│   └── workflows/
│       └── python-app.yml # CI + Codecov
├── README.md              # PyPI description
├── pyproject.toml         # PEP 621 config
├── LICENSE                # Required for PyPI
├── MANIFEST.in            # Source dist inclusion
└── .gitignore

---

📦 Installation

1️⃣ Install via PyPI (recommended)

pip install timed-prompt

2️⃣ Clone the repository (optional / development)

git clone https://github.com/kumarmuthu/timed-prompt
cd timed-prompt

---

▶️ Usage

Normal mode (prompt displayed)

from timed_prompt import timed_input_or_getpass

# Prompt displayed normally, 30s timeout
pw = timed_input_or_getpass("Password (30s timeout): ", 30)

if pw is None:
    print("Timed out")
else:
    print(f"Password entered (length): {len(pw)}")

⚠️ Security note: Avoid printing actual passwords in production.

Quiet mode (prompt not printed)

from timed_prompt import timed_input_or_getpass

# Quiet mode: prompt not shown, useful for automated scripts
pw = timed_input_or_getpass("Enter password: ", 20, quiet=True)

if pw is None:
    print("Timed out (quiet mode)")
else:
    print(f"Password entered (quiet mode, length): {len(pw)}")

---

📁 Example script

python examples/demo.py

Or via CLI entry point after installation:

timed-prompt-demo

---

Author

Created and maintained by kumarmuthu.

---

📝 License

MIT License Feel free to use, modify, and contribute.

---