Chromite

✨ About

Chromite is a lightweight, zero-dependency Python library for building rich terminal user interfaces (TUI). It offers an elegant, object-oriented toolkit for styling output, handling interactive input, and rendering custom UI components.

An optimized library that simplifies writing code and helps with the tasks provided.

📦 Installation

Via pip (Recommended)

pip install Chromite

From source

git clone https://github.com/NastyaNoTamashii/Chromite
cd Chromite
pip install -e .

🚀 Quick start

from Chromite import Color, Style, Write

Write("Hello, Chromite!", compose=[Color.Green, Style.Bold]).display()

🎨 Inline markup

Use $style$ for colors/styles and :emoji: for emoji right inside the text. $reset$ clears everything.

from Chromite import Write

Write("$bold$Build passed$reset$ :white_check_mark: $hex#FFFF00$2 warnings$reset$ :warning:").display()
Write("$bg_red$$white$ ERROR $reset$ disk is full").display()

🌈 Colors

from Chromite import Color, ColorBG, Write

Write("From HEX", compose=Color.hex("#ff5733")).display()
Write("Red background", compose=ColorBG.Red).display()
Write("256-color palette", compose=Color.x256(208)).display()

📋 Lists

from Chromite import List, Color, Style

List.numbered(
    ["Install", "Import", "Enjoy"],
    compose=Color.Cyan,
    bullet_compose=Style.Bold,
).display()

List.pointed(["fast", "no dependencies"], bullet="→", bullet_compose=Color.Green).display()

📊 Tables

from Chromite import Table

table = Table(style = Chromite.TableStyle.Rounded)

table.add_column("Name", compose=Color.Gold)
contacts = table.add_column("Contacts :tada:")
table.add_column("Email", parent=contacts)
chats = table.add_column("Messengers", parent=contacts)
table.add_column("Telegram", parent=chats)
table.add_column("WhatsApp", parent=chats)
table.add_column("Age", align="right")

table.add_row("Oleg", "oleg@gmail.com", "@oleg", "+38(098)000-00-00", 25, compose=Color.Red)
table.add_row("Natalka", "natalka@outlook.com", "@natalka", None, 31)

table.display()

╭─────────┬────────────────────────────────────────────────────┬─────╮
│         │                    Contacts 🎉                     │     │
│         ├─────────────────────┬──────────────────────────────┤     │
│  Name   │                     │          Messengers          │ Age │
│         │        Email        ├──────────┬───────────────────┤     │
│         │                     │ Telegram │     WhatsApp      │     │
├─────────┼─────────────────────┼──────────┼───────────────────┼─────┤
│ Oleg    │ oleg@gmail.com      │ @oleg    │ +38(098)000-00-00 │  25 │
│ Natalka │ natalka@outlook.com │ @natalka │                   │  31 │
╰─────────┴─────────────────────┴──────────┴───────────────────┴─────╯

⌨️ Input

from Chromite import Read, Color

name = Read("Your name > ", compose=Color.Blue, value_compose=Color.LightBlue).execute()
pin = Read("PIN > ", type="pin").execute() # also: "password", "hidden", "int"

print(f"Hi {name}!")

If a feature doesn't work, check if your console supports it.