Skip to main content

Convert iTerm2 profile colors XML file to RGB

Project description

Convert iTerm2 profile colors to RGB dataset

As a user of iTerm2 and a developer that wants to use python packages supporting colorization such as Rich, I want to extract the colors from my iTerm2 Profile into an RGB dataset that provides:

  • Background (R,G,B)
  • Foreground (R,G,B)
  • List of 8 "normal" colors of (R, G, B)
  • List of 8 "bright" colors of (R, G, B)

Usage

You will first need to export your profile colors from iTerm, as described in the section below. You can then either use this package directly or programaticaly.

direct module
Consider an iTerm profile with color values that look like this in the app:

colors in iTerm

After exporting these settings to the default filename "Untitled.itemcolors", run python:

python -m iterm2_colors2rgb Untitled.itermcolors

Outputs (formatted for clarity):

(
   (0, 0, 0), 
   (199, 199, 199), 
   [(0, 0, 0), (201, 27, 0), (0, 194, 0), (199, 196, 0), (2, 37, 199), (202, 48, 199), (0, 197, 199), (199, 199, 199), (104, 104, 104)], 
   [(255, 110, 103), (95, 250, 104), (255, 252, 103), (104, 113, 255), (255, 119, 255), (96, 253, 255), (255, 255, 255)]
)

programmatic

from iterm2_colors2rgb import iterm2_colors2rgb

# as a tuple (bg, fb, normal_list, bright_list)
colors = iterm2_colors2rgb("Untitled.itermcolors")

Installation

pip install iterm2-colors2rgb

Exporting Profile Colors from iTerm

export steps

Steps:

  1. Open the iTerm2 app settings
  2. Select the Prefrences option
  3. Select the Profiles option
  4. Select the profile that you want to export
  5. Click the Color Presents ... dropdown to reveal the Export option
  6. Click the Export option

You will then be presented with a Save File diaglog box which allows you to choose the name and location where you want to save your settings.

Usage with Rich TerminalTheme

If you are using the Rich package and you want to save your console output to file with thes colors you can

from rich.console import TerminalTheme, Console

HTML_SAVE_THEME = TerminalTheme(
    (0, 0, 0),
    (199, 199, 199),
    [(0, 0, 0),
     (201, 27, 0),
     (0, 194, 0),
     (199, 196, 0),
     (2, 37, 199),
     (202, 48, 199),
     (0, 197, 199),
     (199, 199, 199),
     (104, 104, 104)],
    [(255, 110, 103),
     (95, 250, 104),
     (255, 252, 103),
     (104, 113, 255),
     (255, 119, 255),
     (96, 253, 255),
     (255, 255, 255)]
)

# create the Console instance with `record=True` to use the save methods
console = Console(record=True)

# ... console.print(...) usage to render text to screen

# now save the console output to an HTML file using the color theme
console.save_html('mytabledata.html', theme=HTML_SAVE_THEME)

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

iterm2-colors2rgb-0.1.1.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

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

iterm2_colors2rgb-0.1.1-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file iterm2-colors2rgb-0.1.1.tar.gz.

File metadata

  • Download URL: iterm2-colors2rgb-0.1.1.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.3

File hashes

Hashes for iterm2-colors2rgb-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3a6bb00b957fbcbe07c34c368b78aa9697a866b598a4e7092660a03a618246ef
MD5 4a47053cae5a39f61da5c5c5ea34ce9f
BLAKE2b-256 95eaac5d509fb8907764c34052c4375d5e760d0b24c8ec637f564d325b06494d

See more details on using hashes here.

File details

Details for the file iterm2_colors2rgb-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: iterm2_colors2rgb-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.3

File hashes

Hashes for iterm2_colors2rgb-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cc44cdb22ee159e2742e4f036a3fd71831bc1274b911264e8d33f1f0aea358e9
MD5 41b975ff8088a683788adf0fdd585c3c
BLAKE2b-256 71e2844542db1061c841a7b8666f720d5808eefa50997193205296614c26f175

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