Skip to main content

Tuiko

Status: work in progress — this project is NOT finished yet.

The API and behavior may change at any time without notice. Do not use it in production. Everything you see here is experimental.

Tuiko is a tiny TUI framework for Python — stdlib-only, zero third-party dependencies. It renders with ANSI escape codes and reads input via msvcrt (Windows) / termios (POSIX).

What works today

  • prompt — single-line text input
  • select — pick one item, with digit jump (0-9)
  • multiselect — pick many items at once (checkboxes)
  • Realtime search (search=True) — type to filter the list live with the matching text highlighted, Inquirer-style: just type and pick; fuzzy=True matches letters in sequence (e.g. sxk finds "Spy x Family")
  • progress — progress bar (percentage) + spinner
  • status — one-line notice
  • session — full-screen mode (alt screen + raw input)
  • Inquirer-style windowed scrolling; card width and items per window adapt to the terminal size automatically

What is missing

  • Full API documentation
  • Integration with other projects (e.g. Indonime)
  • Battle-tested stability — expect rough edges

Quick usage

from tuiko import prompt, select, session

with session():
    name = prompt("What's your name?", hint="[ESC] quit")
    choice = select("Pick:", ["One", "Two"], search=True, fuzzy=True)

Customization

All text, icons, and colors can be overridden via tuiko.ui and tuiko.theme:

import tuiko

tuiko.ui.cursor = "▌"              # input cursor
tuiko.ui.banner = "★ Tuiko"        # wordmark
tuiko.ui.hint_select = "[↑/↓] Move · [ENTER] Select · [ESC] Cancel"

Examples

  • examples/custom_ui.py — override all text & icons
  • examples/anime_search.py — anime search demo in the style of Indonime (mock data)

Run the demo

python -m tuiko

Tests

python -m unittest discover -s tests -v

Philosophy

Instead of patching InquirerPy via monkeypatching, all widgets are fully under our control — more stable and easier to understand.

Download files

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

Source Distribution

tuiko-0.1.3.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

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

tuiko-0.1.3-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file tuiko-0.1.3.tar.gz.

File metadata

  • Download URL: tuiko-0.1.3.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.15

File hashes

Hashes for tuiko-0.1.3.tar.gz
Algorithm Hash digest
SHA256 0c1d96dd5dd3f74121a975322206c433b18384ba42f712500da9cd17d7a10dfc
MD5 b4b5a056fff2bd3a69de6851815af1b1
BLAKE2b-256 ea68e1d5a42753753ec1498377deacf2b8df212c9b3947712c4ffaf6c2051c9a

See more details on using hashes here.

File details

Details for the file tuiko-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: tuiko-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.15

File hashes

Hashes for tuiko-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f5b4d634e473c6e25d3c8a9aef63ff463614c5a8b9e760bae2b309c77834f23c
MD5 0b886cdbf4c2da1b5f154f979f60b867
BLAKE2b-256 de7b10fd63302dfb8dd39d4b869958ef7f58e73feca197018b7f923abe32ac18

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page