🌈
Colorist for Python
🌈
Lightweight Python package that makes it easy and fast to print terminal messages in colors.
Prerequisites
- Python 3.9 or higher
- macOS
- It may work on Windows or Linux, but hasn't been tested
Installation
PyPI
pip3 install colorist
Homebrew
If you already have installed the Homebrew package manager for Mac and Linux, use this terminal command to tap Colorist for Python:
brew tap jakob-bagterp/colorist
And then install:
brew install colorist
Colors
Getting Started
Full Terminal Output
How to print a full line of colored text in the terminal:
from colorist import green, yellow, red
green("This is GREEN!")
yellow("This is YELLOW!")
red("This is RED!")
How it appears in the terminal:
Custom Terminal Output
How to customize terminal messages and change color inside a paragraph:
from colorist import Color
print(f"I want {Color.RED}red{Color.OFF} color inside this paragraph")
print(f"Both {Color.GREEN}green{Color.OFF} and {Color.YELLOW}yellow{Color.OFF} are nice colors")
How it appears in the terminal:
from colorist import BrightColor
print(f"I want {BrightColor.CYAN}cyan{BrightColor.OFF} color inside this paragraph")
How it appears in the terminal:
Remember to use Color.OFF or BrightColor.OFF every time you want to revert back to the default terminal text style. Otherwise the color may spill over and into other terminal messages.
Other String Formats
It's easier and more readable to use f-strings as in the examples above, but you can also use string format:
from colorist import Color
print("I want {0}red{1} color inside this paragraph".format(Color.RED, Color.OFF))
How it appears in the terminal:
Supported Text Colors
| Color | Full Text Function | Custom | Example |
|---|---|---|---|
 |
green("text") | Color.GREEN |  |
 |
yellow("text") | Color.YELLOW |  |
 |
red("text") | Color.RED |  |
 |
magenta("text") | Color.MAGENTA |  |
 |
blue("text") | Color.BLUE |  |
 |
cyan("text") | Color.CYAN |  |
 |
white("text") | Color.WHITE |  |
 |
black("text") | Color.BLACK |  |
| - | - | Color.OFF | - |
 |
bright_green("text") | BrightColor.GREEN |  |
 |
bright_yellow("text") | BrightColor.YELLOW |  |
 |
bright_red("text") | BrightColor.RED |  |
 |
bright_magenta("text") | BrightColor.MAGENTA |  |
 |
bright_blue("text") | BrightColor.BLUE |  |
 |
bright_cyan("text") | BrightColor.CYAN |  |
 |
bright_white("text") | BrightColor.WHITE |  |
 |
bright_black("text") | BrightColor.BLACK |  |
| - | - | BrightColor.OFF | - |
Effects
Getting Started
In addition to colors, Colorist for Python can also add effects to text messages in the terminal.
Full Terminal Output
How to print a full line of text effect in the terminal:
from colorist import effect_blink
effect_blink("This is BLINKING!")
How it appears in the terminal:
And this can also be combined with an optional color:
from colorist import Color, effect_blink
effect_blink("This is BLINKING!", Color.CYAN)
How it appears in the terminal:
Custom Terminal Output
How to customize terminal messages and change effect inside a paragraph:
from colorist import Effect
print(f"I want {Effect.UNDERLINE}underlined text{Effect.UNDERLINE_OFF} inside this paragraph")
print(f"I want {Effect.BOLD}emphasized text{Effect.BOLD_OFF} inside this paragraph")
How it appears in the terminal:
Effects can also be mixed with colors:
from colorist import Color, Effect
print(f"I want both {Color.RED}colored and {Effect.BLINK}blinking{Effect.BLINK_OFF} text{Color.OFF} inside this paragraph")
Similar to Color.OFF and BrightColor.OFF, remember to turn off an effect with the relevant reset option (e.g Effect.BOLD_OFF, Effect.BOLD_OFF, etc. or even just Effect.OFF) every time you want to revert back to the default terminal text style. Otherwise the effect may spill over and into other terminal messages.
Supported Effects
| Effect | Full Text Function | Custom | Reset | Example |
|---|---|---|---|---|
| Bold | effect_bold("text") | Effect.BOLD | Effect.BOLD_OFF |  |
| Dim | effect_dim("text") | Effect.DIM | Effect.DIM_OFF |  |
| Underline | effect_underline("text") | Effect.UNDERLINE | Effect.UNDERLINE_OFF |  |
| Blink | effect_blink("text") | Effect.BLINK | Effect.BLINK_OFF |  |
| Reverse | effect_reverse("text") | Effect.REVERSE | Effect.REVERSE_OFF |  |
| Hide | effect_hide("text") | Effect.HIDE | Effect.HIDE_OFF |  |
| - | - | - | Effect.OFF | - |
Donate
This module is free to use. And if you like it, feel free to buy me a coffee.
Contribute
If you have suggestions or changes to the module, feel free to add to the code and create a pull request.
Report Bugs
Report bugs and issues here.
![[pre-commit.ci] pre-commit autoupdate](https://avatars.githubusercontent.com/in/68672?v=4)
269 Dec 20, 2022
5 Jul 30, 2022
146 Dec 07, 2022
2 Sep 21, 2022
1.1k Jan 03, 2023
1 Dec 01, 2021
13 Nov 28, 2022
8 Jan 09, 2023
1 Jan 02, 2022
2 Jan 05, 2022
37 Dec 15, 2022
4 Feb 15, 2022
7 Jun 06, 2022
2 Apr 07, 2022
10 Oct 02, 2022
303 Jan 03, 2023
11 Sep 10, 2021
40 Jan 03, 2023
1 Jan 22, 2022
1 Jan 03, 2022