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.1.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.1-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: color_cli-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 bc64dcad0f317804ea2b5e0f5e8928de57bf01e89e653f9d811669b63eb8607e
MD5 cf5d2d56ba843091c366de59bef5ce49
BLAKE2b-256 c5118e51b6678608e7f3de8cabf1dd938f582116543d985ae4a1308ef512bbce

See more details on using hashes here.

File details

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

File metadata

  • Download URL: color_cli-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 854e110cd7cbb737d0db2a6fc46e24b9abb466296a296ebb21ef8bc43e9fa990
MD5 4b29664d1bfbd0c7ba190e5d1660ac27
BLAKE2b-256 61f6b4af4dae77a2d250d7a403d3a15ff3fa1656d8f264d8c72f9d6c1e150eee

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