felixalb
/
cprint-python
mirror of https://github.com/felixalbrigtsen/cprint-python.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update readme.md

This commit is contained in:
Felix Albrigtsen 2021-03-23 21:39:54 +01:00 committed by GitHub
parent 52c8af3722
commit 3827a945f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
readme.md
View File

@ -1,23 +1,28 @@
#cprint for Python
cprint / colorPrint is a simple prettyprint function for python using ANSI escape characters. cprint / colorPrint is a simple prettyprint function for python using ANSI escape characters.
Call cprint(str), inserting the cprint codes surrounded by percent signs(Ex. below). Call cprint(str), inserting the cprint codes surrounded by percent signs(Ex. below).
Using getString(str) directly returns a string instead of printing to stdout. Using getString(str) directly returns a string instead of printing to stdout.
Several color tags and modifiers can be used in the same tag if they are separated by a comma Several color tags and modifiers can be used in the same tag if they are separated by a comma
Colors ###
Text colors are denoted with the first lower case letter Text colors are denoted with the first lower case letter
-> (r)ed (g)reen (b)lue (c)yan (m)agenta (y)ellow (bl)ack (w)hite -> (r)ed (g)reen (b)lue (c)yan (m)agenta (y)ellow (bl)ack (w)hite
Background colors are the same, but with a leading "b" Background colors are the same, but with a leading "b"
Modifiers ###Modifiers
(B)old (U)nderlined (I)nverted/reversed (RS)=reset/default (B)old (U)nderlined (I)nverted/reversed (RS)=reset/default
Macros/Shortcuts ###Macros/Shortcuts
(warning) = Yellow, Bold (warning) = Yellow, Bold
(error) = Red , Bold, Underlined (error) = Red , Bold, Underlined
Example code: ###Example code:
''' ```
from cprint import * from cprint import *
cprint("%bc,r%This is pretty high visibility %y%with different colors")
cprint("%bw,b%This text is blue on white, %B,U,I% this is bold, underlined and white on blue") cprint("%bw,b%This text is blue on white, %B,U,I% this is bold, underlined and white on blue")
''' cprint("%warning%This is a warning!")
Prints the following cprint("%error%And this is an error")
```
![Screenshot of example code](cprint-screenshot.jpg "Example")