Skip to main content

🍚 ricekit

A developer's TUI suite for Textual.

The themes, widgets, modals, icons, and design rules extracted from building ltui — and now powering its whole family (jtui, sctui, same repo) — everything a fast, clean, rice-friendly terminal app needs, minus the app.

ricekit gallery

what's in the box

module contents
ricekit.themes five themes — mocha, OLED-black void, monochrome onyx, clear (transparent: your terminal's blur shows through), system (your terminal's own ANSI palette) — all sharing one $kit-* CSS variable contract, with the scrollbar/selection fixes baked in
ricekit.palette swappable chrome palette (palette.text, .dim, .blue, …) that flips to terminal ANSI colors under the system theme
ricekit.app KitApp — registers the themes, flips ansi_color for transparent themes, injects CSS variables, replaces the palette's theme command with a live-preview picker
ricekit.widgets NavList (vim keys, quiet cursor), Splitter (drag-to-resize with persistence hook, double-click reset), KitScroll, KitFooter (self-measuring Footer — trims trailing keys until it fits, guaranteed zero horizontal overflow), pop_in (the one sanctioned animation)
ricekit.modals PickerModal (generic chooser), ThemeModal (restyles the app live as you scroll), HelpModal (keybinding cheatsheet from plain data)
ricekit.icons curated nerd-font icons as \uXXXX escapes + unicode state glyphs (◌ ○ ◐ ◑ ● ⊘) + mini bar gauges
ricekit.fx text effects — the letter wave (Wave + wave_markup: Gheat → gHeat → …) and braille spinner frames, driven by one cheap shared ticker
ricekit.storage AppDirs — XDG state/cache/config with merge-on-save state and chmod-600 secrets
DESIGN.md the philosophy: cache-first speed, shape language, color roles, motion rules — and the appendix of Textual sharp edges that each cost a day to find

see it

uv tool install git+https://github.com/Gheat1/ricekit
ricekit-gallery

The gallery demos the palette, icons, glyphs, widgets, and modals — cycle themes with t, live-preview every Textual theme with ctrl+p, drag the divider, press ?.

use it

uv add git+https://github.com/Gheat1/ricekit   # or pip install git+…
from textual.binding import Binding

from ricekit import KitApp, icons, palette
from ricekit.storage import AppDirs
from ricekit.widgets import KitFooter, NavList

DIRS = AppDirs("myapp")

class MyApp(KitApp):
    BINDINGS = [Binding("t", "cycle_kit_theme", "theme")]
    CSS = """
    NavList { border: round $kit-border; }
    NavList:focus { border: round $kit-border-focus; }
    """

    def compose(self):
        yield NavList(id="items")
        yield KitFooter()

    def on_mount(self):
        self.init_kit(theme=DIRS.load_state().get("theme"))

    def on_kit_theme_changed(self):
        if not self.kit_theme_previewing:
            DIRS.save_state({"theme": self.theme})

That's a themed, transparent-capable, live-previewing app in ~25 lines. Read DESIGN.md before building anything serious — especially the sharp-edges table.

the suite

  • the tracker TUI suite — ltui (Linear), jtui (Jira), sctui (Shortcut); where all of this came from, now backed by Pantheon
  • NaviTui — an animated terminal player for Navidrome, cover art and all
  • yours next?

license

MIT — made by @Gheat1

Download files

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

Source Distribution

ricekit-0.3.0.tar.gz (21.1 kB view details)

Uploaded Source

Built Distribution

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

ricekit-0.3.0-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file ricekit-0.3.0.tar.gz.

File metadata

  • Download URL: ricekit-0.3.0.tar.gz
  • Upload date:
  • Size: 21.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for ricekit-0.3.0.tar.gz
Algorithm Hash digest
SHA256 419d3ba470083cc68bdadd89e6d8138c7f42067c74b42aac9038429667e4f1e6
MD5 29477d655684bc0f4124db3f236d5ea0
BLAKE2b-256 99deeb185717fba55701cdaddf9fa434d96f00eab06eaf94ec9c7a8bf8c9f3be

See more details on using hashes here.

Provenance

The following attestation bundles were made for ricekit-0.3.0.tar.gz:

Publisher: publish.yml on Gheat1/ricekit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ricekit-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: ricekit-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for ricekit-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 891da87c8d1b8ecdd82ed56cfd48ee8d0e0ceff420385584e10d79522d27869e
MD5 0aea1dd364aa474fb8ebefcf0be195d3
BLAKE2b-256 94c74f0318a39b48c58f0d1f1255bb77448c576469da0c8f4e7fae42385fc535

See more details on using hashes here.

Provenance

The following attestation bundles were made for ricekit-0.3.0-py3-none-any.whl:

Publisher: publish.yml on Gheat1/ricekit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 files

0.2.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page