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

  • example.py — full flow with custom text & colors
  • 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.1.tar.gz (16.3 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.1-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tuiko-0.1.1.tar.gz
  • Upload date:
  • Size: 16.3 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.1.tar.gz
Algorithm Hash digest
SHA256 4068988c6e193a0415e09c651ec5f2c931516fe0182a05a2b1c61ed7e1a9efd0
MD5 f877126b1f4267c4142f03d1701ab3e7
BLAKE2b-256 f6e634739a9c402fa22aebff2fb6651fa34dd699b83eac740a62b13ea8c0961e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tuiko-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 12.0 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9fdac259612c725dcc7f3af88af3bf1432a24e12ec79586d281f86983a26914c
MD5 7778eca25319a1a69da4940ce18e97ff
BLAKE2b-256 36fc8280f79d6df7dc2cc39af03339dd55a6db17919d576f5328d57ff73ce270

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