cobra-color 0.3.0

A Python library for enhanced terminal display.

🐱‍👤 cobra-color 🐱‍👤

About

A lightweight Python library for enhanced terminal display: simple text color/style conventions and image-to-terminal rendering.

• Python: 3.9+
• Runtime deps: Pillow (>=9,<11), NumPy (>=1.21,<2)

Features

• 🚀 Concise color/style names for terminal text.
• 🚀 Image rendering in multiple modes: ASCII, color, half-color, gray, half-gray.
• 🚀 Minimal dependencies and easy integration.

Installation

Stable (once published):

pip install cobra-color

Quick Start

• Render a text in the terminal:

  from cobra_color import ctext, smart_print
  
  c_text_1 = ctext("Hello World!", fg="r", styles=["bold"])
  # Print directly from the terminal
  print(c_text_1)
  
  c_text_2 = ctext("Hello World!", fg=(255, 255, 255), styles=["udl", "bold"])
  # Alternatively, you can use smart_print() to automatically support progress bar modes like tqdm and rich.
  smart_print(c_text_2)
  
  # Merge `c_text_1` and `c_text_2` while preserving their colors and style formatting.
  c_text_3 = c_text_1 + c_text_2
  
  # You can continue to use str's proprietary functions and keep the existing colors and styles.
  c_text_1.upper()
  

• Render an image in the terminal:

  from cobra_color.draw import fmt_image, smart_print
  
  # ASCII art
  smart_print(fmt_image("example.jpg", width=80, mode="ascii"))
  
  # Half-block color (recommended for truecolor terminals)
  smart_print(fmt_image("example.jpg", width=80, mode="half-color"))
  

• Render some text with fonts in the terminal:

  from cobra_color.draw import fmt_font, FontName, smart_print
  
  # Borderless grayscale font
  smart_print(fmt_font("Hello World!", font=FontName.LLDISCO,, mode="half-gray", trim_border=True))
  

Image Modes

• ascii: monochrome ASCII using a density charset.
• color: colorized character fill.
• half-color: half-block characters with color (higher density, good visual quality).
• gray: grayscale characters.
• half-gray: half-block grayscale.

Tip: For best results, use a TrueColor-capable terminal and a monospaced font.

Requirements

• Python >= 3.9
• Pillow >= 9.0, < 11
• NumPy >= 1.21, < 2.0

License

See LICENSE in the repository.

Links

• Homepage/Repo: https://github.com/tinchen777/cobra-color.git
• Issues: https://github.com/tinchen777/cobra-color.git/issues