ansinout 1.0.0__tar.gz

ansinout-1.0.0/.gitignore

@@ -0,0 +1,10 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+build/
+dist/
+.venv/
+venv/
+.env
+.pytest_cache/

ansinout-1.0.0/LICENSE

@@ -0,0 +1,48 @@
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+    You must give any other recipients of the Work or Derivative Works a copy of this License; and
+    You must cause any modified files to carry prominent notices stating that You changed the files; and
+    You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+    If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

ansinout-1.0.0/PKG-INFO

@@ -0,0 +1,280 @@
+Metadata-Version: 2.4
+Name: ansinout
+Version: 1.0.0
+Summary: A dependency-free Python library for building Terminal User Interfaces.
+Author-email: Erin Clemmer <erin.c.clemmer@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ansi,cli,console,ncurses,terminal,tui
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Terminals
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+## ANSINOUT (ANSI + IN + OUT)
+
+A small, dependency-free Python library for building Terminal User Interfaces.
+
+Ansinout provides a thin layer over raw ANSI escape codes without the weight of a full framework.
+
+* **Zero dependencies.** Only uses the standard library.
+* **Keyboard input utils** Easy to use functions for reading user input.
+* **Easy styling** Foreground/background colors and bold are arguments on the text primitive.
+* **Diff-based rendering.** Only cells that have changed since the last frame are written to the terminal.
+
+## Usage
+
+A typical program follows this lifecycle: enter VT mode, build a window, loop on input and repaint, then restore the terminal on exit.
+
+```python
+from ansinout import (
+    enable_vt_mode, exit_vt_mode,
+    TuiWindow, TuiText, TermText,
+    read_key, key_available, PressedKey,
+    Color, BgColor,
+)
+
+fd, attrs = enable_vt_mode()
+try:
+    win = TuiWindow(size=(40, 10), pos=(0, 0))
+    hello = win.add_text(TermText("Hello, world!", fg=Color.Cyan), pos=(0, 0))
+    win.paint()
+
+    while True:
+        if key_available(0.05):
+            key, raw = read_key()
+            if key == PressedKey.Escape:
+                break
+        win.paint()
+finally:
+    exit_vt_mode(fd, attrs)
+```
+
+### Screen lifecycle
+
+#### `enable_vt_mode() -> (fd, old_attrs)`
+
+Prepares the terminal for interactive use. The function captures the current termios attributes of standard input, switches the input file descriptor into cbreak mode so that key presses are delivered without line buffering, enters the alternate screen buffer, clears it, and moves the cursor to the home position. It returns a tuple containing the standard input file descriptor and the original termios attributes, which must be retained and passed to `exit_vt_mode` during shutdown.
+
+```python
+fd, attrs = enable_vt_mode()
+```
+
+#### `exit_vt_mode(fd, old_attrs)`
+
+Restores the terminal to the state it was in before `enable_vt_mode` was called. The function leaves the alternate screen buffer, returning the terminal to the primary screen, and restores the original termios attributes captured by `enable_vt_mode`. The `fd` and `old_attrs` arguments must be the values returned from that call. It should typically be invoked inside a `finally` block to ensure the terminal is restored regardless of how the program exits.
+
+```python
+exit_vt_mode(fd, attrs)
+```
+
+### TUI building blocks
+
+#### `TermText(value, fg=None, bg=None, bold=False)`
+
+A `TermText` pairs a string with an optional foreground color, an optional background color, and a bold flag. It is accepted by every TUI primitive that renders text. The styling applies uniformly to the entire string.
+
+```python
+title = TermText("Inbox", fg=Color.White, bg=BgColor.Blue, bold=True)
+```
+
+#### `TuiText`
+
+The object returned by `TuiWindow.get_text`. It wraps a `TermText` value together with an `id`, a `position`, a derived `size`, and a `hidden` flag. Instances are created by `TuiWindow.add_text` rather than constructed directly.
+
+#### `TuiWindow(size, pos)`
+
+The main container. A `TuiWindow` owns a grid of cells with dimensions equal to `size` and a list of `TuiText` objects positioned within it. The window itself is anchored at `pos`, which is interpreted as an absolute `(column, row)` offset in the terminal. All `TuiText` positions are relative to the window's anchor.
+
+```python
+win = TuiWindow(size=(80, 24), pos=(0, 0))
+```
+
+##### `add_text(value, pos) -> int`
+
+Adds a `TermText` to the window at the given relative `(column, row)` position and returns an integer id. The id is used by every other method that operates on a specific text object.
+
+```python
+tid = win.add_text(TermText("Press Esc to quit", fg=Color.Gray), pos=(0, 23))
+```
+
+##### `update_text(id, value, pos=None)`
+
+Replaces the contents and/or position of an existing text object. If `value` is `None`, the existing text is preserved and only the position is changed. If `pos` is `None`, the position is preserved. Cells previously occupied by the old text are cleared so the next `paint()` removes any stale characters.
+
+```python
+win.update_text(tid, TermText("Bye!", fg=Color.Red))
+win.update_text(tid, None, pos=(10, 5))
+win.update_text(tid, TermText("Hi"), (0, 0))
+```
+
+##### `get_text(id) -> TuiText`
+
+Returns the underlying `TuiText` instance for the given id or `None` if not found.
+
+```python
+obj = win.get_text(tid)
+```
+
+##### `hide_txt(id)` and `show_txt(id)`
+
+`hide_txt` marks the text object as hidden and clears the cells it currently occupies so the next paint erases it from the terminal. The text object and its id remain in the window and can be redisplayed with `show_txt`, which clears the hidden flag and rewrites the text into the grid.
+
+```python
+win.hide_txt(tid)
+win.show_txt(tid)
+```
+
+##### `hide_all()` and `show_all()`
+
+Hide or show every text object currently in the window.
+
+```python
+win.hide_all()
+win.show_all()
+```
+
+##### `remove_txt(id)` and `remove_all()`
+
+`remove_txt` clears the cells occupied by the text object and removes it from the window's text list. `remove_all` performs the same operation for every text object in the window.
+
+```python
+win.remove_txt(tid)
+win.remove_all()
+```
+
+##### `update_position(pos)`
+
+Moves the window to a new absolute `(column, row)` anchor. The function hides all currently visible text objects, paints the cleared state to remove the old rendering, updates the anchor, and restores visibility at the new location.
+
+```python
+win.update_position((5, 2))
+```
+
+##### `clear_screen()`
+
+Replaces every cell in the window's grid with a space. This stages a full erase that takes effect on the next `paint()`. It does not remove text objects from the window.
+
+```python
+win.clear_screen()
+```
+
+##### `paint()`
+
+Flushes pending changes to the terminal. The method walks the grid and writes only the cells whose contents differ from what was last painted, then returns the cursor to the origin. Because the operation is incremental, `paint()` is safe to call in a tight render loop.
+
+```python
+win.paint()
+```
+
+### Keyboard input
+
+#### `key_available(timeout=0.0) -> bool`
+
+Reports whether standard input has data ready to be read. The call blocks for at most `timeout` seconds and returns `True` as soon as input becomes available, or `False` if the timeout elapses first. A timeout of `0.0` performs a non-blocking poll. The function is typically used in a render loop to wait briefly for input without preventing periodic repaints.
+
+```python
+if key_available(0.05):
+    key, raw = read_key()
+```
+
+#### `read_key() -> (PressedKey, str)`
+
+Reads a single key press from standard input and returns a tuple of `(PressedKey, raw)`, where `PressedKey` is the categorized key and `raw` is the underlying byte sequence as a string. The function handles multi-byte escape sequences for the arrow keys and the Delete key, and distinguishes a bare Escape press from the start of an escape sequence by waiting briefly for continuation bytes. Unknown escape sequences are reported as `PressedKey.Nop` with the full received sequence as the raw value.
+
+```python
+key, raw = read_key()
+if key == PressedKey.Alpha:
+    buffer += raw
+elif key == PressedKey.Backspace:
+    buffer = buffer[:-1]
+```
+
+#### `PressedKey`
+
+An enumeration of the key categories produced by `read_key`. The members are `Alpha`, `ArrowUp`, `ArrowDown`, `ArrowLeft`, `ArrowRight`, `Backspace`, `Enter`, `Escape`, `Delete`, and `Nop`. The `Alpha` category covers letters, digits, and a set of punctuation characters (`_`, `-`, `.`, `/`, `\`, and `:`). Bytes that do not match any recognized category are reported as `Nop`.
+
+### Cursor functions
+
+#### `move_cursor(row, col)`
+
+Moves the terminal cursor to the given zero-based `(row, col)` position without writing any text. The function is useful for placing the cursor after a series of direct writes, or for positioning a visible cursor over an input field. Errors raised while writing the escape sequence are suppressed.
+
+```python
+move_cursor(0, 0)
+```
+
+#### `change_cursor(cursor_type)`
+
+Changes the shape of the terminal cursor. The `cursor_type` argument is a member of the `CursorTypes` enumeration, which defines six shapes: `Default`, `Blinking_Block`, `Steady_Block`, `Blinking_Underline`, `Steady_Underline`, `Blinking_Bar`, and `Steady_Bar`. The effect persists until the next call to `change_cursor` or until the terminal is reset.
+
+```python
+from ansinout.screen import CursorTypes, change_cursor
+change_cursor(CursorTypes.Steady_Bar)
+```
+
+### Direct drawing
+
+#### `print_pos(row, col, s, fg=None, bg=None, bold=False)`
+
+Writes the string `s` at the given zero-based `(row, col)` position. The function emits the ANSI cursor-positioning sequence followed by the styled text and flushes standard output. Coordinates are translated to the terminal's one-based addressing internally, so the caller should pass zero-based values. Styling arguments behave as on `TermText`: omitting `fg`, `bg`, and `bold` produces unstyled output.
+
+```python
+print_pos(2, 5, "status: ok", fg=Color.Green, bold=True)
+```
+
+
+### Colors
+
+#### `Color` and `BgColor`
+
+Enumerations of the sixteen standard ANSI color codes for foreground and background respectively. Each enum covers the eight base colors and their eight bright variants, along with a `Default` member that maps to the terminal's configured default. The two enums are kept distinct so that the type system can prevent a background color from being passed where a foreground color is expected. Values are accepted by `TermText`, `print_pos`, and any other function that takes `fg` or `bg` arguments.
+
+```python
+TermText("warning", fg=Color.BrightYellow, bg=BgColor.Black, bold=True)
+```
+
+#### Standard colors
+
+| Name | ANSI (fg) | ANSI (bg) |
+| --- | --- | --- |
+| `Black` | 30 | 40 |
+| `Red` | 31 | 41 |
+| `Green` | 32 | 42 |
+| `Yellow` | 33 | 43 |
+| `Blue` | 34 | 44 |
+| `Magenta` | 35 | 45 |
+| `Cyan` | 36 | 46 |
+| `White` | 37 | 47 |
+| `Default` | 39 | 49 |
+
+#### Bright colors
+
+| Name | ANSI (fg) | ANSI (bg) |
+| --- | --- | --- |
+| `BrightBlack` | 90 | 100 |
+| `Gray` | 90 | 100 |
+| `BrightRed` | 91 | 101 |
+| `BrightGreen` | 92 | 102 |
+| `BrightYellow` | 93 | 103 |
+| `BrightBlue` | 94 | 104 |
+| `BrightMagenta` | 95 | 105 |
+| `BrightCyan` | 96 | 106 |
+| `BrightWhite` | 97 | 107 |
+
+`Gray` is an alias for `BrightBlack`. The exact rendering of each color is determined by the terminal's color scheme.

ansinout-1.0.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "ansinout"
+version = "1.0.0"
+description = "A dependency-free Python library for building Terminal User Interfaces."
+readme = "readme.md"
+requires-python = ">=3.8"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Erin Clemmer", email = "erin.c.clemmer@gmail.com" },
+]
+keywords = ["tui", "terminal", "ansi", "console", "cli", "ncurses"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: Unix",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Terminals",
+    "Environment :: Console",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ansinout"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/ansinout",
+    "readme.md",
+    "LICENSE",
+]

ansinout-1.0.0/readme.md

@@ -0,0 +1,252 @@
+## ANSINOUT (ANSI + IN + OUT)
+
+A small, dependency-free Python library for building Terminal User Interfaces.
+
+Ansinout provides a thin layer over raw ANSI escape codes without the weight of a full framework.
+
+* **Zero dependencies.** Only uses the standard library.
+* **Keyboard input utils** Easy to use functions for reading user input.
+* **Easy styling** Foreground/background colors and bold are arguments on the text primitive.
+* **Diff-based rendering.** Only cells that have changed since the last frame are written to the terminal.
+
+## Usage
+
+A typical program follows this lifecycle: enter VT mode, build a window, loop on input and repaint, then restore the terminal on exit.
+
+```python
+from ansinout import (
+    enable_vt_mode, exit_vt_mode,
+    TuiWindow, TuiText, TermText,
+    read_key, key_available, PressedKey,
+    Color, BgColor,
+)
+
+fd, attrs = enable_vt_mode()
+try:
+    win = TuiWindow(size=(40, 10), pos=(0, 0))
+    hello = win.add_text(TermText("Hello, world!", fg=Color.Cyan), pos=(0, 0))
+    win.paint()
+
+    while True:
+        if key_available(0.05):
+            key, raw = read_key()
+            if key == PressedKey.Escape:
+                break
+        win.paint()
+finally:
+    exit_vt_mode(fd, attrs)
+```
+
+### Screen lifecycle
+
+#### `enable_vt_mode() -> (fd, old_attrs)`
+
+Prepares the terminal for interactive use. The function captures the current termios attributes of standard input, switches the input file descriptor into cbreak mode so that key presses are delivered without line buffering, enters the alternate screen buffer, clears it, and moves the cursor to the home position. It returns a tuple containing the standard input file descriptor and the original termios attributes, which must be retained and passed to `exit_vt_mode` during shutdown.
+
+```python
+fd, attrs = enable_vt_mode()
+```
+
+#### `exit_vt_mode(fd, old_attrs)`
+
+Restores the terminal to the state it was in before `enable_vt_mode` was called. The function leaves the alternate screen buffer, returning the terminal to the primary screen, and restores the original termios attributes captured by `enable_vt_mode`. The `fd` and `old_attrs` arguments must be the values returned from that call. It should typically be invoked inside a `finally` block to ensure the terminal is restored regardless of how the program exits.
+
+```python
+exit_vt_mode(fd, attrs)
+```
+
+### TUI building blocks
+
+#### `TermText(value, fg=None, bg=None, bold=False)`
+
+A `TermText` pairs a string with an optional foreground color, an optional background color, and a bold flag. It is accepted by every TUI primitive that renders text. The styling applies uniformly to the entire string.
+
+```python
+title = TermText("Inbox", fg=Color.White, bg=BgColor.Blue, bold=True)
+```
+
+#### `TuiText`
+
+The object returned by `TuiWindow.get_text`. It wraps a `TermText` value together with an `id`, a `position`, a derived `size`, and a `hidden` flag. Instances are created by `TuiWindow.add_text` rather than constructed directly.
+
+#### `TuiWindow(size, pos)`
+
+The main container. A `TuiWindow` owns a grid of cells with dimensions equal to `size` and a list of `TuiText` objects positioned within it. The window itself is anchored at `pos`, which is interpreted as an absolute `(column, row)` offset in the terminal. All `TuiText` positions are relative to the window's anchor.
+
+```python
+win = TuiWindow(size=(80, 24), pos=(0, 0))
+```
+
+##### `add_text(value, pos) -> int`
+
+Adds a `TermText` to the window at the given relative `(column, row)` position and returns an integer id. The id is used by every other method that operates on a specific text object.
+
+```python
+tid = win.add_text(TermText("Press Esc to quit", fg=Color.Gray), pos=(0, 23))
+```
+
+##### `update_text(id, value, pos=None)`
+
+Replaces the contents and/or position of an existing text object. If `value` is `None`, the existing text is preserved and only the position is changed. If `pos` is `None`, the position is preserved. Cells previously occupied by the old text are cleared so the next `paint()` removes any stale characters.
+
+```python
+win.update_text(tid, TermText("Bye!", fg=Color.Red))
+win.update_text(tid, None, pos=(10, 5))
+win.update_text(tid, TermText("Hi"), (0, 0))
+```
+
+##### `get_text(id) -> TuiText`
+
+Returns the underlying `TuiText` instance for the given id or `None` if not found.
+
+```python
+obj = win.get_text(tid)
+```
+
+##### `hide_txt(id)` and `show_txt(id)`
+
+`hide_txt` marks the text object as hidden and clears the cells it currently occupies so the next paint erases it from the terminal. The text object and its id remain in the window and can be redisplayed with `show_txt`, which clears the hidden flag and rewrites the text into the grid.
+
+```python
+win.hide_txt(tid)
+win.show_txt(tid)
+```
+
+##### `hide_all()` and `show_all()`
+
+Hide or show every text object currently in the window.
+
+```python
+win.hide_all()
+win.show_all()
+```
+
+##### `remove_txt(id)` and `remove_all()`
+
+`remove_txt` clears the cells occupied by the text object and removes it from the window's text list. `remove_all` performs the same operation for every text object in the window.
+
+```python
+win.remove_txt(tid)
+win.remove_all()
+```
+
+##### `update_position(pos)`
+
+Moves the window to a new absolute `(column, row)` anchor. The function hides all currently visible text objects, paints the cleared state to remove the old rendering, updates the anchor, and restores visibility at the new location.
+
+```python
+win.update_position((5, 2))
+```
+
+##### `clear_screen()`
+
+Replaces every cell in the window's grid with a space. This stages a full erase that takes effect on the next `paint()`. It does not remove text objects from the window.
+
+```python
+win.clear_screen()
+```
+
+##### `paint()`
+
+Flushes pending changes to the terminal. The method walks the grid and writes only the cells whose contents differ from what was last painted, then returns the cursor to the origin. Because the operation is incremental, `paint()` is safe to call in a tight render loop.
+
+```python
+win.paint()
+```
+
+### Keyboard input
+
+#### `key_available(timeout=0.0) -> bool`
+
+Reports whether standard input has data ready to be read. The call blocks for at most `timeout` seconds and returns `True` as soon as input becomes available, or `False` if the timeout elapses first. A timeout of `0.0` performs a non-blocking poll. The function is typically used in a render loop to wait briefly for input without preventing periodic repaints.
+
+```python
+if key_available(0.05):
+    key, raw = read_key()
+```
+
+#### `read_key() -> (PressedKey, str)`
+
+Reads a single key press from standard input and returns a tuple of `(PressedKey, raw)`, where `PressedKey` is the categorized key and `raw` is the underlying byte sequence as a string. The function handles multi-byte escape sequences for the arrow keys and the Delete key, and distinguishes a bare Escape press from the start of an escape sequence by waiting briefly for continuation bytes. Unknown escape sequences are reported as `PressedKey.Nop` with the full received sequence as the raw value.
+
+```python
+key, raw = read_key()
+if key == PressedKey.Alpha:
+    buffer += raw
+elif key == PressedKey.Backspace:
+    buffer = buffer[:-1]
+```
+
+#### `PressedKey`
+
+An enumeration of the key categories produced by `read_key`. The members are `Alpha`, `ArrowUp`, `ArrowDown`, `ArrowLeft`, `ArrowRight`, `Backspace`, `Enter`, `Escape`, `Delete`, and `Nop`. The `Alpha` category covers letters, digits, and a set of punctuation characters (`_`, `-`, `.`, `/`, `\`, and `:`). Bytes that do not match any recognized category are reported as `Nop`.
+
+### Cursor functions
+
+#### `move_cursor(row, col)`
+
+Moves the terminal cursor to the given zero-based `(row, col)` position without writing any text. The function is useful for placing the cursor after a series of direct writes, or for positioning a visible cursor over an input field. Errors raised while writing the escape sequence are suppressed.
+
+```python
+move_cursor(0, 0)
+```
+
+#### `change_cursor(cursor_type)`
+
+Changes the shape of the terminal cursor. The `cursor_type` argument is a member of the `CursorTypes` enumeration, which defines six shapes: `Default`, `Blinking_Block`, `Steady_Block`, `Blinking_Underline`, `Steady_Underline`, `Blinking_Bar`, and `Steady_Bar`. The effect persists until the next call to `change_cursor` or until the terminal is reset.
+
+```python
+from ansinout.screen import CursorTypes, change_cursor
+change_cursor(CursorTypes.Steady_Bar)
+```
+
+### Direct drawing
+
+#### `print_pos(row, col, s, fg=None, bg=None, bold=False)`
+
+Writes the string `s` at the given zero-based `(row, col)` position. The function emits the ANSI cursor-positioning sequence followed by the styled text and flushes standard output. Coordinates are translated to the terminal's one-based addressing internally, so the caller should pass zero-based values. Styling arguments behave as on `TermText`: omitting `fg`, `bg`, and `bold` produces unstyled output.
+
+```python
+print_pos(2, 5, "status: ok", fg=Color.Green, bold=True)
+```
+
+
+### Colors
+
+#### `Color` and `BgColor`
+
+Enumerations of the sixteen standard ANSI color codes for foreground and background respectively. Each enum covers the eight base colors and their eight bright variants, along with a `Default` member that maps to the terminal's configured default. The two enums are kept distinct so that the type system can prevent a background color from being passed where a foreground color is expected. Values are accepted by `TermText`, `print_pos`, and any other function that takes `fg` or `bg` arguments.
+
+```python
+TermText("warning", fg=Color.BrightYellow, bg=BgColor.Black, bold=True)
+```
+
+#### Standard colors
+
+| Name | ANSI (fg) | ANSI (bg) |
+| --- | --- | --- |
+| `Black` | 30 | 40 |
+| `Red` | 31 | 41 |
+| `Green` | 32 | 42 |
+| `Yellow` | 33 | 43 |
+| `Blue` | 34 | 44 |
+| `Magenta` | 35 | 45 |
+| `Cyan` | 36 | 46 |
+| `White` | 37 | 47 |
+| `Default` | 39 | 49 |
+
+#### Bright colors
+
+| Name | ANSI (fg) | ANSI (bg) |
+| --- | --- | --- |
+| `BrightBlack` | 90 | 100 |
+| `Gray` | 90 | 100 |
+| `BrightRed` | 91 | 101 |
+| `BrightGreen` | 92 | 102 |
+| `BrightYellow` | 93 | 103 |
+| `BrightBlue` | 94 | 104 |
+| `BrightMagenta` | 95 | 105 |
+| `BrightCyan` | 96 | 106 |
+| `BrightWhite` | 97 | 107 |
+
+`Gray` is an alias for `BrightBlack`. The exact rendering of each color is determined by the terminal's color scheme.

ansinout-1.0.0/src/ansinout/__init__.py

@@ -0,0 +1,3 @@
+from ansinout.keyboard import key_available, read_key, PressedKey
+from ansinout.screen import enable_vt_mode, exit_vt_mode, move_cursor, change_cursor, print_pos, Color, BgColor
+from ansinout.tui import TermText, TuiWindow, TuiText

ansinout-1.0.0/src/ansinout/keyboard.py

@@ -0,0 +1,63 @@
+import sys
+import os
+import select
+from typing import Tuple
+from enum import Enum
+
+def key_available(timeout: float = 0.0):
+    rlist, _, _ = select.select([sys.stdin.fileno()], [], [], timeout)
+    return bool(rlist)
+
+class PressedKey(Enum):
+    Alpha = "Alpha"
+    ArrowUp = "ArrowUp"
+    ArrowDown = "ArrowDown"
+    ArrowLeft = "ArrowLeft"
+    ArrowRight = "ArrowRight"
+    Backspace = "Backspace"
+    Enter = "Enter"
+    Escape = "Escape"
+    Delete = "Delete"
+    Nop = "Nop"
+
+def _read_byte() -> str:
+    data = os.read(sys.stdin.fileno(), 1)
+    return data.decode("utf-8", errors="ignore") if data else ""
+
+def read_key() -> Tuple[PressedKey, str]:
+    accepted_chars = ["_", "-", ".", "/", "\\", ":"]
+    ch = _read_byte()
+    if ch.isalpha() or ch.isnumeric() or ch in accepted_chars:
+        return PressedKey.Alpha, ch
+    if ch == "\n" or ch == "\r":
+        return PressedKey.Enter, ch
+    if ch == "\x7f":
+        return PressedKey.Backspace, ch
+    if ch == "\x1b":
+        # Distinguish bare Escape from escape sequences (arrows/delete/etc.)
+        # by waiting briefly for continuation bytes.
+        if not key_available(0.02):
+            return PressedKey.Escape, ch
+
+        seq = ""
+        # Read a short sequence like "[A" or "[3~".
+        while key_available(0.001) and len(seq) < 8:
+            seq += _read_byte()
+            # Common final bytes for CSI key sequences.
+            if seq and (seq[-1].isalpha() or seq[-1] == "~"):
+                break
+
+        if seq == "[A":
+            return PressedKey.ArrowUp, seq
+        if seq == "[B":
+            return PressedKey.ArrowDown, seq
+        if seq == "[D":
+            return PressedKey.ArrowLeft, seq
+        if seq == "[C":
+            return PressedKey.ArrowRight, seq
+        if seq == "[3~":
+            return PressedKey.Delete, seq
+
+        # Fallback: unknown escape sequence acts as Escape.
+        return PressedKey.Nop, seq
+    return PressedKey.Nop, ""

ansinout-1.0.0/src/ansinout/screen.py

@@ -0,0 +1,113 @@
+import sys
+import termios
+import tty
+from enum import Enum
+from typing import Optional
+
+ESC = "\x1b["
+ALT_SCR_ENTER = f"{ESC}?1049h"
+ALT_SCR_EXIT  = f"{ESC}?1049l"
+CLS = f"{ESC}2J"
+HOME = f"{ESC}H"
+
+def write(s: str):
+    sys.stdout.write(s)
+    sys.stdout.flush()
+
+def enable_vt_mode():
+    fd_in = sys.stdin.fileno()
+    old_in_attrs = termios.tcgetattr(fd_in)
+    tty.setcbreak(fd_in)
+    write(ALT_SCR_ENTER + CLS + HOME)
+    return (fd_in, old_in_attrs)
+
+def exit_vt_mode(fd_in, old_in_attrs):
+    write(ALT_SCR_EXIT)
+    termios.tcsetattr(fd_in, termios.TCSADRAIN, old_in_attrs)
+
+def print_pos(row: int, col: int, s: str, fg: Optional['Color'] = None, bg: Optional['BgColor'] = None, bold: bool = False):
+    # ANSI positions are 1-based
+    s = color(s, fg, bg, bold)
+    write(f"{ESC}{row + 1};{col + 1}H{s}")
+
+def move_cursor(row: int, col: int):
+    try:
+        write(f"{ESC}{row + 1};{col + 1}H")
+    except Exception:
+        pass
+
+class CursorTypes(Enum):
+    Default = 1
+    Blinking_Block = 1
+    Steady_Block = 2
+    Blinking_Underline = 3
+    Steady_Underline = 4
+    Blinking_Bar = 5
+    Steady_Bar = 6
+
+def change_cursor(t: CursorTypes):
+    write(f"\033[{t.value} q")
+
+class Color(Enum):
+    # Standard foreground colors (30-37)
+    Black = 30
+    Red = 31
+    Green = 32
+    Yellow = 33
+    Blue = 34
+    Magenta = 35
+    Cyan = 36
+    White = 37
+    Default = 39
+    # Bright foreground colors (90-97)
+    BrightBlack = 90
+    Gray = 90
+    BrightRed = 91
+    BrightGreen = 92
+    BrightYellow = 93
+    BrightBlue = 94
+    BrightMagenta = 95
+    BrightCyan = 96
+    BrightWhite = 97
+
+
+class BgColor(Enum):
+    # Standard background colors (40-47)
+    Black = 40
+    Red = 41
+    Green = 42
+    Yellow = 43
+    Blue = 44
+    Magenta = 45
+    Cyan = 46
+    White = 47
+    Default = 49
+    # Bright background colors (100-107)
+    BrightBlack = 100
+    Gray = 100
+    BrightRed = 101
+    BrightGreen = 102
+    BrightYellow = 103
+    BrightBlue = 104
+    BrightMagenta = 105
+    BrightCyan = 106
+    BrightWhite = 107
+
+
+def color(text: str, fg: Optional[Color] = None, bg: Optional[BgColor] = None, bold: bool = False) -> str:
+    codes = []
+    if bold:
+        codes.append("1")
+
+    if isinstance(fg, Color):
+        codes.append(str(fg.value))
+
+    if isinstance(bg, BgColor):
+        codes.append(str(bg.value))
+
+    if len(codes) == 0:
+        return text
+
+    prefix = f"\033[{';'.join(codes)}m"
+    reset = "\033[0m"
+    return f"{prefix}{text}{reset}"

ansinout-1.0.0/src/ansinout/tui.py

@@ -0,0 +1,228 @@
+from typing import List, Tuple, Optional
+from ansinout.screen import print_pos, Color, BgColor
+
+class TermText:
+    value: str
+    fg: Optional[Color]
+    bg: Optional[BgColor]
+    bold: bool
+
+    def __init__(self, v: str, fg: Optional[Color] = None, bg: Optional[BgColor] = None, bold: bool = False):
+        self.value = v
+        self.fg = fg
+        self.bg = bg
+        self.bold = bold
+
+class TuiCell:
+    text: TermText
+    last_paint_ch: str
+    
+    position: Tuple[int, int]
+    committed: bool
+
+    def __init__(self, v: TermText, pos: Tuple[int, int]):
+        self.text = v
+        self.position = pos
+        self.committed = True
+        self.last_paint_ch = v.value
+
+    def set_value(self, tt: TermText):
+        if not isinstance(tt, TermText):
+            raise Exception(f"Tried to set cell value for non string {tt}")
+        if len(tt.value) > 1:
+            raise Exception("Tried to set cell with more than one character")
+        if tt.value == self.text.value:
+            return
+        self.text = tt
+        self.committed = tt.value == self.last_paint_ch
+
+    def paint(self, abs_position: Tuple[int, int]):
+        if self.committed:
+            return
+        print_pos(abs_position[1], abs_position[0], self.text.value, self.text.fg, self.text.bg, self.text.bold)
+        self.committed = True
+        self.last_paint_ch = self.text.value
+
+class TuiGrid:
+    size: Tuple[int, int]
+    position: Tuple[int, int]
+    grid: List[List[TuiCell]]
+
+    def __init__(self, size: Tuple[int, int], pos: Tuple[int, int]):
+        self.size = size
+        self.position = pos
+        self.grid = []
+        for x in range(0, self.size[0]):
+            rows = []
+            for y in range(0, self.size[1]):
+                rows.append(TuiCell(TermText(""), (x, y)))
+            self.grid.append(rows)
+
+    def set_cell(self, pos: Tuple[int, int], tt: TermText):
+        if pos[0] > self.size[0] or pos[1] > self.size[1]:
+            return
+        if pos[0] < 0 or pos[1] < 0:
+            return
+        try:
+            self.grid[pos[0]][pos[1]].set_value(tt)
+        except IndexError:
+            pass
+
+    def paint(self):
+        for row in self.grid:
+            for cell in row:
+                cell.paint((
+                    self.position[0] + cell.position[0],
+                    self.position[1] + cell.position[1]
+                ))
+        print_pos(0, 0, '')
+
+class TuiText:
+    id: int
+    hidden: bool
+    text: TermText
+    size: Tuple[int, int]
+    position: Tuple[int, int]
+
+    def __init__(self, id: int, v: TermText, pos: Tuple[int, int]):
+        self.id = id
+        if not isinstance(v, TermText):
+            raise Exception("TuiText must use TermText")
+        self.text = v
+        self.position = pos
+        self.hidden = False
+        self._update_size()
+        
+    def _update_size(self):
+        max_len = 0
+        lines = self.text.value.split("\n")
+        for i in range(0, len(lines)):
+            if len(lines[i]) > max_len:
+                max_len = len(lines[i])
+        
+        self.size = (max_len, len(lines))
+
+    def update_value(self, v: TermText):
+        if not isinstance(v, TermText):
+            raise Exception("TuiText must use TermText")
+        self.text = v
+        self._update_size()
+
+    def get_cells(self) -> List[Tuple[TermText, Tuple[int, int]]]:
+        cells = []
+        lines = self.text.value.split("\n")
+        for x in range(0, self.size[0]):
+            for y in range(0, self.size[1]):
+                if x > len(lines[y]) - 1:
+                    continue
+                tt = TermText(lines[y][x], self.text.fg, self.text.bg, self.text.bold)
+                cells.append((tt, (
+                    self.position[0] + x, 
+                    self.position[1] + y
+                )))
+        return cells
+
+class TuiWindow(TuiGrid):
+    _current_id: int
+    text_objects: List[TuiText]
+
+    def __init__(self, size: Tuple[int, int], pos: Tuple[int, int]):
+        super().__init__(size, pos)
+        self._current_id = 0
+        self.text_objects = []
+
+    def get_text(self, id: int) -> Optional[TuiText]:
+        objs = [o for o in self.text_objects if o.id == id]
+        if len(objs) == 0:
+            return None
+        return objs[0]
+
+    def add_text(self, v: TermText, pos: Tuple[int, int]) -> int:
+        self.text_objects.append(TuiText(self._current_id, v, pos))
+        self._current_id += 1
+        self._update_grid()
+        return self._current_id - 1
+    
+    def clear_text(self, id: int):
+        txt = self.get_text(id)
+        if txt is None:
+            return
+        whitespace_v = TermText(''.join((c if c.isspace() else ' ') for c in txt.text.value))
+        whitespace_obj = TuiText(-1, whitespace_v, txt.position)
+        for clear_v, rel_pos in whitespace_obj.get_cells():
+            self.set_cell((
+                rel_pos[0],
+                rel_pos[1]
+            ), clear_v)
+
+    def hide_txt(self, id: int):
+        txt = self.get_text(id)
+        if txt is None:
+            return
+        txt.hidden = True
+        self.clear_text(id)
+
+    def hide_all(self):
+        for txt in self.text_objects:
+            self.hide_txt(txt.id)
+            
+    def show_txt(self, id: int):
+        txt = self.get_text(id)
+        if txt is None:
+            return
+        txt.hidden = False
+        self._update_grid()
+
+    def show_all(self):
+        for txt in self.text_objects:
+            self.show_txt(txt.id)
+
+    def remove_txt(self, id: int):
+        self.clear_text(id)
+        self.text_objects = [t for t in self.text_objects if t.id != id]
+
+    def remove_all(self):
+        for txt in list(self.text_objects):
+            self.remove_txt(txt.id)
+
+    def update_text(self, id: int, v: Optional[TermText], pos: Optional[Tuple[int, int]] = None):
+        txtObj = self.get_text(id)
+
+        if txtObj is None:
+            return
+        
+        self.clear_text(id)
+
+        if v is not None:
+            txtObj.update_value(v)
+        
+        if pos is not None:
+            txtObj.position = pos
+
+        self._update_grid()
+
+    def update_position(self, pos: Tuple[int, int]):
+        shown =  [o.id for o in self.text_objects if not o.hidden]
+        
+        self.hide_all()
+        self.clear_screen()
+        self.paint()
+        self.position = pos
+        for tid in shown:
+            self.show_txt(tid)
+        self.paint()
+    
+    def clear_screen(self):
+        for x in range(0, self.size[0]):
+            for y in range(0, self.size[1]):
+                self.set_cell((x, y), TermText(" "))
+
+    def _update_grid(self):
+        for obj in self.text_objects:
+            if obj.hidden:
+                continue
+            for v, rel_pos in obj.get_cells():
+                    self.set_cell((
+                        rel_pos[0],
+                        rel_pos[1]
+                    ), v)