color-cli 0.1.0

A simple coloring util for better output visibility

ColorME

A lightweight Python package to add color and character to your command-line output.

Table of Content

• Description
• Features
• Usage
• Supported Colors & Attributes
• License
• Future Work

Description

This package will house a utility package that will help the users to be able to customize and colorize their function outputs to better standout in their terminal.

Features

• Support 8 colors and 4 styles
• Useful for CLI tools, scripts and developer logs
• Cross-platform via termcolor

Installation

Install locally for development:

git clone https://github.com/Abdulrahman-K-S/colorME.git
cd colorME
pip install -e .

Or use it in your project:

pip install git+https://github.com/Abdulrahman-K-S/colorME.git

Usage

from colorme import color_text

# Basic output
print(color_text('Hello World!', color='green'))

# With attributes
print(color_text('WARNING!', color='red', attrs=['bold', 'underline']))

Supported Colors & Attributes

Colors:

grey, red, green, yellow, blue, magenta, cyan, white

Attributes:

bold, underline, reverse, blink

License

This project is licensed under the Apache License 2.0.

Future Work

• Add a support for background colors
• Add CLI features such as colorme 'hello' --color blue --attrs bold
• Add more customization

Contributors

A huge thank you to all the contributors!

If you want to be a contributor check the CONTRIBUTING.md file.