Skip to main content

A Python library for enhanced terminal display.

Project description

🐱‍👤 cobra-color 🐱‍👤

PyPI version Python Tests codecov License

Pull Requests Welcome Github stars

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

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-0.2.10.tar.gz (64.3 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-0.2.10-py3-none-any.whl (64.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cobra_color-0.2.10.tar.gz
Algorithm Hash digest
SHA256 7f7340ac50f19c5af79877c6873c4d620b560fc23d0b24222f18afad21eecb37
MD5 9f7ab36afa3e07da4fbff126319b8a03
BLAKE2b-256 77fdb6f4df3408cc1fd5eb748ca663271970bffd6bbab6cba7aa1ad70bf5e1b9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cobra_color-0.2.10-py3-none-any.whl
  • Upload date:
  • Size: 64.9 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-0.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 05df0434a220d7d4dd0d2e905d13af85097c4fe4a5f2326156ad414a82c6d630
MD5 a52ecd702dddf82c3e372b583582add7
BLAKE2b-256 80dd3b39e2dcad5768b02ce7ef45c509920acfc7cf65951ad2800d4eb0f6f580

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