Skip to main content

A lightweight, easy-to-use Python library for enhanced terminal output, combining string-friendly color styling with one-step ANSI image rendering.

Project description

🎨 cobra-color 🎨
Turn a Plain Terminal into an Expressive Visual Canvas

PyPI version Python codecov License

Tests Github stars

About

cobra-color is a lightweight, easy-to-use Python library for enhanced terminal output, combining string-friendly color styling with one-step ANSI image rendering.

  • Python: 3.9+

Features

  • 🚀 Strong compatibility with native Python strings: Keep familiar str workflows while preserving color/style through operations like concatenation and transformations.
  • 🚀 Full terminal rendering toolkit: Supports both styled text output and image-to-ANSI conversion across multiple modes (such as ascii, half-color, and gray).
  • 🚀 Lightweight and developer-friendly: Minimal core dependencies, optional render extras, and safe_print support for tqdm/rich-friendly console output.

Installation

Install from PyPI

This installs the core package with minimal dependencies.

pip install cobra-color

Install with Optional Dependencies

cobra.render module support.

pip install cobra-color[render]

Quick Start

  • Render a text in the terminal:

    from cobra_color import cstr, safe_print
    
    c_text_1 = cstr("Hello World!", fg="r", styles=["bold"])
    # Print directly from the terminal
    print(c_text_1)
    
    c_text_2 = cstr("Hello World!", fg=(255, 255, 255), styles=["udl", "bold"])
    # Alternatively, you can use safe_print() to automatically support progress bar modes like tqdm and rich.
    safe_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.render import imgfile_to_ansi, safe_print
    
    # ASCII art
    safe_print(imgfile_to_ansi("example.jpg", width=80, mode="ascii"))
    
    # Half-block color (recommended for truecolor terminals)
    imgfile_to_ansi("example.jpg", width=80, mode="half-color", display=True)
    
  • Render some text with fonts in the terminal:

    from cobra_color.draw import fonttext_to_ansi, FontName, safe_print
    
    # Borderless grayscale font
    safe_print(fonttext_to_ansi(
        "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
  • (Optional) Pillow >= 9.0, < 11.0
  • (Optional) NumPy >= 1.21, < 2.0

License

See LICENSE in the repository.

Links

Project details


Download files

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

Source Distribution

cobra_color-1.3.12.tar.gz (32.2 kB view details)

Uploaded Source

Built Distribution

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

cobra_color-1.3.12-py3-none-any.whl (33.8 kB view details)

Uploaded Python 3

File details

Details for the file cobra_color-1.3.12.tar.gz.

File metadata

  • Download URL: cobra_color-1.3.12.tar.gz
  • Upload date:
  • Size: 32.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for cobra_color-1.3.12.tar.gz
Algorithm Hash digest
SHA256 7155cd26e64ec7b4f31f8d059fa73d2af5d84a833e7dbeb3d56de9a9e3acc05f
MD5 38fc840b23fe62c719620b38c27fd6fa
BLAKE2b-256 9000743da8ae97d10e1f5b0b6e9c1c0f791ca305398191e1331507c3dde6b012

See more details on using hashes here.

File details

Details for the file cobra_color-1.3.12-py3-none-any.whl.

File metadata

  • Download URL: cobra_color-1.3.12-py3-none-any.whl
  • Upload date:
  • Size: 33.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for cobra_color-1.3.12-py3-none-any.whl
Algorithm Hash digest
SHA256 e7cf8c241bd5e926cd92eb25919df3be80de0177fdbef42d40e9906009648768
MD5 066b578cd031b90255da7f9f33ef6af8
BLAKE2b-256 980cc05a112d9661d8c8aa55a0882fb26d30e0710032191e17d6a1dd730062b1

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