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 implementations Supported Python versions CI status of Linux/macOS/Windows CodeQL 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", "green", etc.) or color code ("#RRGGBB")

  • styles
    • "bold", "italic", etc.

Other examples

Apply true color and styles to text:

https://github.com/thombashi/tcolorpy/blob/master/ss/styles.png

example source code

You can also specify colors by name:

https://github.com/thombashi/tcolorpy/blob/master/ss/ansi_colors.png

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.9+ no external dependencies.

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

tcolorpy-0.1.7.tar.gz (299.4 kB view details)

Uploaded Source

Built Distribution

tcolorpy-0.1.7-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file tcolorpy-0.1.7.tar.gz.

File metadata

  • Download URL: tcolorpy-0.1.7.tar.gz
  • Upload date:
  • Size: 299.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for tcolorpy-0.1.7.tar.gz
Algorithm Hash digest
SHA256 0fbf6bf238890bbc2e32662aa25736769a29bf6d880328f310c910a327632614
MD5 6232d098c4531507e2aa04fe34fb8cd3
BLAKE2b-256 80cc44f2d81d8f9093aad81c3467a5bf5718d2b5f786e887b6e4adcfc17ec6b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for tcolorpy-0.1.7.tar.gz:

Publisher: release.yml on thombashi/tcolorpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tcolorpy-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: tcolorpy-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for tcolorpy-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 26a59d52027e175a37e0aba72efc99dda43f074db71f55b316d3de37d3251378
MD5 07640b00fad88519fc0b41a6d2b008ef
BLAKE2b-256 05a2ed023f2edd1e011b4d99b6727bce8253842d66c3fbf9ed0a26fc09a92571

See more details on using hashes here.

Provenance

The following attestation bundles were made for tcolorpy-0.1.7-py3-none-any.whl:

Publisher: release.yml on thombashi/tcolorpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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