Metadata-Version: 2.4
Name: betterInput
Version: 0.1.0
Summary: A Windows-only timed console input extension for Python.
License: MIT
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: C
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# betterInput

`betterInput` is a Windows-only Python package that provides a timed console input function implemented as a C extension.

## Requirements

- Windows
- Python 3.9+
- Microsoft C++ Build Tools compatible with your Python version

## Installation

```powershell
pip install .
```

## Usage

```python
import betterInput

value, remaining, elapsed = betterInput.input(
    prompt=">>> ",
    timeout=10,
    format="{prompt}{input} | %s",
    countdown=0,
)

print(value, remaining, elapsed)
```

`betterInput.input()` returns a tuple:

- `(text, remaining_seconds, elapsed_seconds)` when the user presses Enter
- `(None, 0.0, timeout_seconds)` when the timeout expires

## Build

```powershell
python -m pip install --upgrade build twine
python -m build
```

## Local Test Install

```powershell
pip install .
python -c "import betterInput; print(betterInput.input)"
```

## Upload

```powershell
twine check dist/*
twine upload dist/*
```

## License

MIT

