Skip to content

Michaelzhouisnotwhite/Colorprt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Colorprt

English | 中文

It's a simple package for you to customize the console printing color.

pypi: https://pypi.org/project/colorprt/

ScreenShots

img.png

New Features

We add some default color config in our package.

from colorprt.default import warn_color, success_color, error_color

warn_color.print("Print a warn message")
success_color.print("Print a success message")
error_color.print("Print an error message")

We found that some people use this package on linux server, so that there is no auto completions. It will trouble users. Therefore, we add a feature that You don't need to type: mode=; foreground=; background=

just call functions or class like this:

In old versions:

from colorprt import colorprt, Back, Fore

# CAUTION: Do not use this after version: 3.0.0
colorprt("Hello World", backgound=Back.RED)

Use new features:

from colorprt import colorprt, Back, Fore

colorprt("Hello World", Back.RED, Fore.YELLOW)

Usage

Installation

pip install colorprt

Detailed Documentation

Function colorprt is a print funtion extention. You can customize the printing style.

from colorprt import colorprt, Back, Fore

hello_else = "Hello Michael"
colorprt("Hello World",hello_else,  Back.RED, Fore.BLUE end="x100 times\n")

scshots01

  • Back stands for background;
  • Fore stands for foreground;
  • Mode stands for printing mode. ( font style like: underline, bold, flash, reverse )

Also, you can use ColorprtConfig class to set colored strings.

from colorprt import ColorprtConfig, Mode, Back, Fore

pycolor_config = ColorprtConfig(Mode.BOLD, Back.DEFAULT, Fore.RED)

# You can use ColorprtConfig to set a color string configuration

colored_formatted_str = pycolor_config("I love You!!")

print(colored_formatted_str)

# or just use print method

pycolor_config.print("I love you!!", end="x10086\n")

If you just want the ansi colored formatted strings, you can use colorstr class.

from colorprt import colorstr, Mode, Back, Fore, ColorprtConfig

hate_print_config = ColorprtConfig(Mode.UNDER_LINE, Back.DEFAULT, Fore.YELLOW)
print(colorstr("I love You!!", Mode.BOLD, Back.DEFAULT, Fore.RED)
      + colorstr("I hate you", hate_print_config))

if you use str() to force change to string. You will get

>>> str(colorstr("I love You!!", Mode.BOLD, Back.DEFAULT, Fore.RED)
      + colorstr("I hate you", hate_print_config))
>>> '\x1b[0m\x1b[1;31mI love You!!\x1b[0m\x1b[4;33mI hate you\x1b[0m\x1b[0m'
from colorprt import colorstr, Mode, Back, Fore, ColorprtConfig

hate_print_config = ColorprtConfig(Mode.UNDER_LINE, Back.DEFAULT, Fore.YELLOW)

output = str(colorstr('I hate You', hate_print_config))

About

python package for printing colorful output

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published