Metadata-Version: 2.1
Name: curses-helper
Version: 0.3.1
Summary: Curses helper stuff.
Home-page: https://github.com/taitep/curses_helper
License: GPLv3
Keywords: curses
Author: taitep
Author-email: arvid@h.se
Requires-Python: >=3.9,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Project-URL: Repository, https://github.com/taitep/curses_helper
Description-Content-Type: text/markdown

# curses_helper

Provides curses helper stuff.

## `@curses_app`
The `@curses_app` decorator can be used as a replacement for wrapper. It takes the following arguments:
- `echo`: Whether to enable echo mode in the terminal. Default=False
- `cbreak`: Whether to enable cbreak mode, allowing reading keyboard input without waiting for enter. Default=True
- `keypad`: Whether to enable curses keypad mode. default=False

## Types
curses_helper provides a types module, providing the following type hinting types:
- `Window`: The curses window type.

All types that cannot be handled at runtime are set to `Any` when the program is being run.
