rong - A console coloring utility for Python 3 (open source).
Project description
Rong - A console coloring utility for Python console apps
Developed by Md. Almas Ali
Version 0.0.2
Installation
It is very easy to install. Like as usual you can install it with pip
.
pip install rong
Documentation
Welcome to Rong documentation,
Here you will learn about a CLI tool which can add color into your CLI bashed project. Highly recomended module in python by developers. Its easy to use and easily adaptable to every lavel developers. Anyone can learn this in 10 min.
Give it a try ?
Project index's
- Color & Style codes
- Log class
- Mark class
- Highlight class
- Text class
- Examples for practice
- Latest changes history
-
Color & Styles
-
All Colors for forground and background:
-
black
-
red
-
green
-
yellow
-
blue
-
purple
-
cyan
-
white
-
orange
-
tomato
-
pink
-
violet
-
gray
-
darkgreen
-
gold
-
yellowgreen
-
sandybrown
-
darkred
-
lightgray
-
lightblue
-
lightgreen
-
lightyellow
-
lightpurple
-
lightcyan
-
lightwhite
-
lightseagreen
-
lightred
-
lightpink
-
lightorange
-
lightviolet
-
transparent
-
-
All Styles:
blink
: for blinking text in consolebold
: for bolding text in consoleclear
: for clearing all setted stylesconcealed
: for concealing text in consoleinvisible
: for making text invisible in consoleitalic
: for italicizing text in consoleoverline
: for overlining text in consolereverse
: for reversing text in consolestrike
: for strike text in consoleunderline
: for underlining text in consoleunderline-solid
: for solid underlining text in consoleunderline-wavy
: for wavy underlining text in consoleunderline-double
: for double underlining text in consoleunderline-dotted
: for dotted underlining text in consoleunderline-dashed
: for dashed underlining text in console
-
NOTE :
- You can use
clear
to clear all setted styles. - When you use
underline
it will beunderline-solid
by default. underline-wavy
,underline-dotted
andunderline-dashed
underline is not supported in all terminals.
- You can use
-
-
Log
: A simple logging text class for coloring text-
To display primary text
primary(text:str)
-
To display blue text
blue(text:str)
-
To display success text
success(text:str)
-
To display green text
green(text:str)
-
To display ok text
ok(text:str)
-
To display warning text
warning(text:str)
-
To display yellow text
yellow(text:str)
-
To display help text
help(text:str)
-
To display danger text
danger(text:str)
-
To display error text
error(text:str)
-
To display fail message
fail(text:str)
-
To display underline
underline(text:str)
-
To display bold text
bold(text:str)
-
To display ok message
okmsg(text:str)
-
To display wait message
waitmsg(text:str)
-
To display error message
errormsg(text:str)
-
-
Mark
: A simple class for coloring manually in line- To add color manually you need to use this class with some constant color which is binded into this class. You have to manually start the color as, this example bellow:
print(f"This is a {Mark.GREEN}sample Mark{Mark.END} test.")
-
Highlight
: A class for highlighing text color-
To get white color
white(text:str)
-
To get bold white color
bwhite(text:str)
-
To get green color
green(text:str)
-
To get bold green color
bgreen(text:str)
-
To get blue color
blue(text:str)
-
To get bold blue color
bblue(text:str)
-
To get yellow color
yellow(text:str)
-
To get bold yellow color
byellow(text:str)
-
To get red color
red(text:str)
-
To get bold red color
bred(text:str)
-
-
Most powerfull, all in one class
Text
-
To add forground / text color
foreground(color:str)
-
To add backgroung color
background(color:str)
-
To add styles as list
style(styles:list)
-
To update object text
update(text:str):
-
To show output text
print()
-
All in one in a single line :
Text(text="Single line test", styles=["bold", "underline-solid"])
-
Some sample codes are for text.
from rong import *
# In line Log display
print(f"I am {Log.waitmsg('Almas')} Ali")
print(f"I am {Log.errormsg('Almas')} Ali")
print(f"I am {Log.warning('Almas')} Ali")
print(f"I am {Log.primary('Almas')} Ali")
# In line color with custom parameter
print(f"{Mark.BLUE} Hi, {Mark.END}")
print(f"{Mark.RED} Hi, {Mark.END}")
print(f"{Mark.GREEN} Hi, {Mark.END}")
print(f"{Mark.CYAN} Hi, {Mark.END}")
print(f"This is a {Mark.GREEN}sample Mark{Mark.END} test.")
# In line text highlighting
print(f"Enjoy {Highlight.red('Almas')}")
print(f"Enjoy {Highlight.bred('Almas')}")
print(f"Enjoy {Highlight.blue('Almas')}")
print(f"Enjoy {Highlight.bblue('Almas')}")
print(f"Enjoy {Highlight.yellow('Almas')}")
print(f"Enjoy {Highlight.byellow('Almas')}")
# Working with Text objects
# Creating Text class object
text = Text(text='Almas Ali')
# Adding forground color / text color
text.foreground('blue')
text.foreground('purple')
# Adding background color
text.background('white')
# Adding custom styles
text.style(styles=['bold', 'underline'])
# Updating object text
text.update(text=' New text ')
# Printing output in two ways
# Advance methode bashed mode
text.print()
# Normal pythonic mode
print(text)
# Doing everything in one line
text1 = Text(text='Demo1', styles=['bold'], fg='blue', bg='white')
text1.print()
# Clearing all styles
text2 = Text(text='Demo', styles=['clear'])
text2.print()
Change History :
0.0.2 - Fixed default background issue, added huge amonut of colors and styles varient. Added more examples and documentation.
0.0.1 - Initialized this project and written all this codes.
Everything is open source. You can contribute in this project by submitting a issue or fixing a problem and make pull request.
Made with love by © Md. Almas Ali
LICENSE under MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.