pytermgui(1)

📦 version 7.7.3, in debian trixie, ubuntu resolute, ubuntu stonking

💖 pytermgui — the manual page, but make it cute 💖

okay so bestie, you've found yourself at the pytermgui page of the manual — it's pytermgui(1), and honestly? it's giving main character energy. Sit down, grab a strawberry 🍓, and let me tell you everything.

✨ NAME ✨

pytermgui — a Python TUI framework with multi-feature support 🦋

✨ SYNOPSIS ✨

ptg  [-h] [--app Getch, Inspect, Color, Tim] [-g] [-t] [-c] [-i PATH_OR_CODE] [-e] [--methods] [--dunder] [--private] [-s]
   [-v] [--palette] [--highlight [SYNTAX]] [--exec [EXEC]] [-f FILE] [--print-only] [--export-svg FILE] [--export-html FILE]

✨ DESCRIPTION ✨

It's a Python TUI framework with mouse support, a modular widget system, a customizable and rapid terminal markup language, and more! 💅 Like, literally all of it. No cap. 🎀

✨ OPTIONS ✨

🌸 options:

  • -h, --help — shows you this help message and then dips. 🫶

🌈 Applications:

--app Getch, Inspect, Color, Tim — launches an app, bestie. Pick your fighter. 👑

  • -g, --getch — launches the Getch app. ✨
  • -t, --tim — launches the TIM Playground app. 🎀
  • -c, --color — launches the ColorPicker app. 🌈

🔍 Inspection:

-i PATH_OR_CODE, --inspect PATH_OR_CODE — inspects an object. 👀 Like, we're looking at it. Closely.

  • -e, --eval — evaluates the expression you handed to --inspect instead of treating it as a path. 🔥
  • --methods — always shows methods when inspecting. periodt.
  • --dunder — always shows __dunder__ methods when inspecting. 💀
  • --private — always shows _private methods when inspecting. 🙈

🛠️ Utilities:

  • -s, --size — outputs the current terminal size in WxH format. 📐
  • -v, --version — prints version & system information. ⭐
  • --palette — prints the default PyTermGUI color palette. 🎨
  • --highlight [SYNTAX] — highlights some python-like code syntax. No argument, or -, will read STDIN. 🦋
  • --exec [EXEC] — executes some Python code. No argument, or -, will read STDIN. 🔥
  • -f FILE, --file FILE — interprets a PTG-YAML file. 🍓
  • --print-only — when interpreting YAML, prints the environment without running it interactively. 👑

📦 Exporters:

  • --export-svg FILE — exports the result of any non-interactive argument as an SVG file. 💜
  • --export-html FILE — exports the result of any non-interactive argument as an HTML file. 💖
ngl bestie, the exporters only do their thing for non-interactive arguments — so don't expect an SVG of your whole live playground session, okay? 🫶

and that's the whole page, no notes. This was pytermgui version 7.7.3+dfsg, dated 08 January 2025, and it's pytermgui(1) — ily, go build something iconic with it 💅✨👑

📦 where this page comes from