README.rst

tcolorpy

• Summary
• Installation
  • Installation: pip
  • Installation: conda
• Usage
  • Library usage
  • CLI usage
• Dependencies

Summary

tcolopy is a Python library to apply true color for terminal text.

Installation

Installation: pip

pip install tcolorpy

Installation: conda

conda install -c conda-forge tcolorpy

Usage

Library usage

Sample Code:	from tcolorpy import tcolor print(tcolor("tcolopy example", color="#ee1177", styles=["bold", "italic", "underline"]))
Output:

You can set the following tcolor arguments:

• color/bg_color

  • color names ("red", "green", etc.) or color code ("#RRGGBB")

• styles

  • "bold", "italic", etc.

Other examples

Apply true color and styles to text:

example source code

You can also specify colors by name:

example source code

CLI usage

tcolorpy can be used via CLI:

$ python3 -m tcolorpy "tcolopy example" -c "#ee1177" -s bold,italic,underline

Command help

usage: __main__.py [-h] [-c COLOR] [-b BG_COLOR] [-s STYLES] [--encode ENCODE] string

positional arguments:
  string                string to apply styles.

options:
  -h, --help            show this help message and exit
  -c COLOR, --color COLOR
                        specify a color code (#XXXXXX) or a name. valid names are: black, red, green, yellow, blue, magenta, cyan, white, lightblack, lightred, lightgreen, lightyellow, lightblue, lightmagenta, lightcyan, lightwhite
  -b BG_COLOR, --bg-color BG_COLOR
                        specify a background color code (#XXXXXX) or a name. valid names are: black, red, green, yellow, blue, magenta, cyan, white, lightblack, lightred, lightgreen, lightyellow, lightblue, lightmagenta, lightcyan, lightwhite
  -s STYLES, --styles STYLES
                        specify a comma-separated style. valid values are: bold, dim, italic, underline, blink, invert, strike
  --encode ENCODE       output a text encoded with the specified encoding

Dependencies

Python 3.7+ no external dependencies.