Skip to main content

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

Project description

Summary

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

PyPI package version conda-forge package version Supported Python versions Supported Python implementations Linux/macOS/Windows CI status Test coverage: coveralls

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:
https://github.com/thombashi/tcolorpy/blob/master/ss/oneline.png

You can set the following tcolor arguments:

  • color/bg_color
    • color names ("red", "red", etc.) or color code ("#RRGGBB")
  • styles
    • "bold", "italic", etc.

Other examples

Apply true color and styles to text:

You can also specify colors by names:

CLI usage

tcolorpy can be used via CLI:

$ python -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.

optional arguments:
  -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 styles. valid values are:
                        bold, dim, italic, underline, blink, invert, strike
  --encode ENCODE       output a text encoded with the specified encoding

Dependencies

Python 3.6+ No external dependencies.

Download files

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

Files for tcolorpy, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size tcolorpy-0.1.1.tar.gz (11.0 kB) File type Source Python version None Upload date Hashes View
Filename, size tcolorpy-0.1.1-py3-none-any.whl (8.0 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page