Skip to content

🌈 Lightweight Python package that makes it easy and fast to print colored text in the terminal 🌈

License

Notifications You must be signed in to change notification settings

jakob-bagterp/colorist-for-python

Repository files navigation

Latest version Python 3.10 | 3.11 | 3.12 or higher BSD-3-Clause license Codecov CodeQL Test Downloads

🌈 Colorist for Python 🌈

Lightweight Python package that makes it easy and fast to print colored text in the terminal.

Ready to try? See how to install.

Getting Started

Print Line of Colored Text

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:

Example of full line of green, yellow, red colored text printed in a terminal window

Print Mixed Text Colors

How to customize colors inside a paragraph and print it in the terminal:

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:

Example of white text mixed with green, yellow, red colors printed in a terminal window

Other Styling Options

Print Bright Colors

Most terminals support bright colors that stand more out:

from colorist import BrightColor

print(f"I want {BrightColor.CYAN}cyan{BrightColor.OFF} color inside this paragraph")

How it appears in the terminal:

Example of white text mixed with cyan printed in a terminal window

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.

Print Background Colors

from colorist import bg_green, bg_yellow, bg_red

bg_green("This is GREEN background!")
bg_yellow("This is YELLOW background!")
bg_red("This is RED background!")

How it appears in the terminal:

Example of white text and colored backgrounds if green, yellow, red printed in a terminal window

Background colors can also be mixed inside a paragraph:

from colorist import BgColor

print(f"I want {BgColor.RED}red{BgColor.OFF} background color inside this paragraph")

print(f"Both {BgColor.GREEN}green{BgColor.OFF} and {BgColor.YELLOW}yellow{BgColor.OFF} are nice background colors")

How it appears in the terminal:

Example of black, green, yellow, red background colors mixed inside paragraph printed in a terminal window

from colorist import BgBrightColor

print(f"I want {BgBrightColor.CYAN}cyan{BgBrightColor.OFF} background color inside this paragraph")

How it appears in the terminal:

Example of white text on a cyan background color printed in a terminal window

As with text colors, remember to use BgColor.OFF or BgBrightColor.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.

Foreground Text

Color Full Text Function Custom Example
Green green("text") Color.GREEN Green text color in terminal
Yellow yellow("text") Color.YELLOW Yellow text color in terminal
Red red("text") Color.RED Red text color in terminal
Magenta magenta("text") Color.MAGENTA Magenta text color in terminal
Blue blue("text") Color.BLUE Blue text color in terminal
Cyan cyan("text") Color.CYAN Cyan text color in terminal
White white("text") Color.WHITE White text color in terminal
Black black("text") Color.BLACK Black text color in terminal
- - Color.DEFAULT -
- - Color.OFF -
Bright green bright_green("text") BrightColor.GREEN Bright green text color in terminal
Bright yellow bright_yellow("text") BrightColor.YELLOW Bright yellow text color in terminal
Bright red bright_red("text") BrightColor.RED Bright red text color in terminal
Bright magenta bright_magenta("text") BrightColor.MAGENTA Bright magenta text color in terminal
Bright blue bright_blue("text") BrightColor.BLUE Bright blue text color in terminal
Bright cyan bright_cyan("text") BrightColor.CYAN Bright cyan text color in terminal
Bright white bright_white("text") BrightColor.WHITE Bright white text color in terminal
Bright black bright_black("text") BrightColor.BLACK Bright black text color in terminal
- - BrightColor.DEFAULT -
- - BrightColor.OFF -

Background

Color Full Text Function Custom Example
Green bg_green("text") BgColor.GREEN Green background color in terminal
Yellow bg_yellow("text") BgColor.YELLOW Yellow background color in terminal
Red bg_red("text") BgColor.RED Red background color in terminal
Magenta bg_magenta("text") BgColor.MAGENTA Magenta background color in terminal
Blue bg_blue("text") BgColor.BLUE Blue background color in terminal
Cyan bg_cyan("text") BgColor.CYAN Cyan background color in terminal
White bg_white("text") BgColor.WHITE White background color in terminal
Black bg_black("text") BgColor.BLACK Black background color in terminal
- - BgColor.DEFAULT -
- - BgColor.OFF -
Bright green bg_bright_green("text") BgBrightColor.GREEN Bright green background color in terminal
Bright yellow bg_bright_yellow("text") BgBrightColor.YELLOW Bright yellow background color in terminal
Bright red bg_bright_red("text") BgBrightColor.RED Bright red background color in terminal
Bright magenta bg_bright_magenta("text") BgBrightColor.MAGENTA Bright magenta background color in terminal
Bright blue bg_bright_blue("text") BgBrightColor.BLUE Bright blue background color in terminal
Bright cyan bg_bright_cyan("text") BgBrightColor.CYAN Bright cyan background color in terminal
Bright white bg_bright_white("text") BgBrightColor.WHITE Bright white background color in terminal
Bright black bg_bright_black("text") BgBrightColor.BLACK Bright black background color in terminal
- - BgBrightColor.DEFAULT -
- - BgBrightColor.OFF -

Thank You for Supporting

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.

About

🌈 Lightweight Python package that makes it easy and fast to print colored text in the terminal 🌈

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages