Skip to main content

A simple coloring util for better output visibility

Project description

Color CLI

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

Table of Content

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/color-CLI.git
cd colorME
pip install -e .

Or use it in your project:

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

Usage

from color_cli 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 color-cli '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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

color_cli-0.1.2.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

color_cli-0.1.2-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file color_cli-0.1.2.tar.gz.

File metadata

  • Download URL: color_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.6

File hashes

Hashes for color_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 db0aa50c5ad21ac502ac7559629e31ab083f1e9ce7fa3629d5f89cfd261cf494
MD5 af84090432f17029a3d2457861996c25
BLAKE2b-256 bb470b13dc63e95307edb02e6ff54df981f55c51f39f6b6057b75f66c36fc8d6

See more details on using hashes here.

File details

Details for the file color_cli-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: color_cli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.6

File hashes

Hashes for color_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 86050a8498c6f157b75ae7574732577b2e4985359180de349163965f6f339935
MD5 9876704158dfdd274f2ef4c22eee8670
BLAKE2b-256 0b0c7276d28367d78194f6140d747f507a99e3d1ab9f0934a852dce50b8be862

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page