Skip to content
/ colorP Public

pip3 package for formatting strings into colored strings using ANSI color codes

License

Notifications You must be signed in to change notification settings

siddg97/colorP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

colorP

This package is a small and simple utility for printing colored strings on consoles. colorP supports 9 different formatting styles and several foreground and background colors!

You can install it by issuing the following command on a UNIX terminal:

sudo pip install -i colorp

Usage:

Methods :-

pPrint(args,text,br=?):

  • args: is a dictionary object, which needs atleast one of s,fg or bg defined with the corresponding values as strings.
args = {'s':'bold','fg':'red','bg':'white'}
  • text: is the string to be printed with the given styling
  • br: [OPTIONAL ARGUMENT: default value= True], can set it to False if you need no linebreak after ouput.

Eg():

  • prints out examples of a few colors and styles for user visualization.

Styling and Formatting:

  • The args object decides how the text will be formatted. Each key in args can be one of certain pre-defined values. They are listed below:
  • 's': Text style
Value Description
'plain' Formats the text as plain text
'bold' Bolds the text
'dim' Dims the text
'italic' Italicizes the text
'underline' Underlines the text
'blink' Blinks the text repeatedly
'reverse' Swaps foreground and background values
'hidden' Hides the text on display
'striked' Strikes off the desired text
  • 'fg': Font color
Value
'black'
'red'
'green'
'yellow'
'blue'
'magenta'
'cyan'
'lightgray'
'darkgray'
lightred'
'lightgreen'
'lightyellow'
'lightblue'
'lightmagenta'
'lightcyan'
'white'
'default'
  • 'bg': Background color
Value
'black'
'red'
'green'
'yellow'
'blue'
'magenta'
'cyan'
'lightgray'
'darkgray'
lightred'
'lightgreen'
'lightyellow'
'lightblue'
'lightmagenta'
'lightcyan'
'white'
'default'
NOTE:
  • 'bg' has the same possible values as 'fg'.

About

pip3 package for formatting strings into colored strings using ANSI color codes

Topics

Resources

License

Stars

Watchers

Forks

Languages