GitLocker: The Coding Marketplace

Description:

Pcolors 0.1

Pcolors

Pcolors is made to simplify printing colors in the console.

:pencil: Table of Contents

:pencil: Table of Contents
🧐   About
🏁   Getting Started

Installing

📚   Usage

cprint
style

🖌   styling rules

color
end
format

✒   shortcuts
✍️   Authors
🔎   Examples

powershell
cmd
windows terminal
pycharm

🧐   About
This package is perfect if you want to display fancy text on the console
without having to worry about ANSI escape codes ASGR sequences and all theses boring an complicated stuff Pcolors do all that for you
🏁   Getting Started
Installing
You can install Pcolors using pip:

pip install Pcolors

to verify the installation you can do

python -m Pcolors

📚   Usage
cprint
cprint() is the base function of Pcolors use it to directly print colored text using the styling rules:
cprint("text", styling rules)
from Pcolors import cprint

cprint("text", fg_color="red", bg_color="lblue")

style
style() is used to define styles using the styling rules:
from Pcolors import style

header = style(
fg_color="green",
bg_color="lblack",
format=["framed", "bold", "underline_bold"],
)

cprint("my header", style=header)
...
cprint("my second header", style=header)

🖌   styling rules
color
use fg_color and bg_color to define the forground color and the background color
from Pcolors import cprint, style

cprint("text", fg_color="red", bg_color="lblue")
style(fg_color="red", bg_color="lblue")

you can use color names:

white / lwhite
cyan / lcyan
magenta / lmagenta
blue / lblue
yellow / lyellow
green / lgreen
red / lred
black / lblack

or you can use codes:

97 / 37
96 / 36
95 / 35
94 / 34
93 / 33
92 / 32
91 / 31
90 / 30

end
use end to define what should be appended to the output, default : "\n"
from Pcolors import cprint, style

cprint("text", fg_color="red", bg_color="lblue", end="")
style(fg_color="red", bg_color="lblue", end="")

defining end to "" make the print don't go to a new line at the end
permitting to print multiple colors on a single line
format
use format to define the formatting of the text
from Pcolors import cprint, style

cprint("text", format=["bold","underline"])
style(format=["bold","underline"])

you can use format names:

normal
bold
faint
italic
underline
slow_blink
rapid_blink
reverse
hidden
crossed
underline_bold
framed
rounded

or you can use codes:

0
1
2
3
4
5
6
7
8
9
21
51
52

✒   shortcuts
you can also use shortcuts for styling :
you can found them in Pcolors.shortcuts
from Pcolors import style
from Pcolors.shortcuts import light, dark, format

header = style(
fg_color=dark.green,
bg_color=light.black,
format=[
format.framed,
format.bold,
format.underline_bold
],
)

or for using manually with code() and styling rules:
from Pcolors import code
from Pcolors.shortcuts import light, dark, format

code(light.green) #>

✍️   Authors

@rafalou38 - Idea & Initial work

🔎   Examples
powershell

cmd

windows terminal

pycharm