ANSI color formatting for output in terminal

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for hugovk from gravatar.com hugovk

Unverified details

These details have not been verified by PyPI
Meta
  • License Expression: MIT
    SPDX License Expression
  • Author: Konstantin Lepa
  • Maintainer: Hugo van Kemenade
  • Tags ANSI, ANSI color, ANSI colour, color, colour, formatting, termcolor, terminal
  • Requires: Python >=3.9
  • Provides-Extra: tests
Classifiers
Report project as malware

Project description

termcolor

PyPI version Supported Python versions PyPI downloads GitHub Actions status Codecov Licence Code style: Black Tidelift

Installation

From PyPI

python3 -m pip install --upgrade termcolor

From source

git clone https://github.com/termcolor/termcolor
cd termcolor
python3 -m pip install .

Demo

To see demo output, run:

python3 -m termcolor

Example

import sys

from termcolor import colored, cprint

text = colored("Hello, World!", "red", attrs=["reverse", "blink"])
print(text)
cprint("Hello, World!", "green", "on_red")

print_red_on_cyan = lambda x: cprint(x, "red", "on_cyan")
print_red_on_cyan("Hello, World!")
print_red_on_cyan("Hello, Universe!")

for i in range(10):
    cprint(i, "magenta", end=" ")

cprint("Attention!", "red", attrs=["bold"], file=sys.stderr)

# You can also specify 0-255 RGB ints via a tuple
cprint("Both foreground and background can use tuples", (100, 150, 250), (50, 60, 70))

Text properties

Text colors Text highlights Attributes
black on_black bold
red on_red dark
green on_green underline
yellow on_yellow blink
blue on_blue reverse
magenta on_magenta concealed
cyan on_cyan strike
white on_white
light_grey on_light_grey
dark_grey on_dark_grey
light_red on_light_red
light_green on_light_green
light_yellow on_light_yellow
light_blue on_light_blue
light_magenta on_light_magenta
light_cyan on_light_cyan

You can also use any arbitrary RGB color specified as a tuple of 0-255 integers, for example, (100, 150, 250).

Terminal properties

Terminal bold dark underline blink reverse concealed
xterm yes no yes bold yes yes
linux yes yes bold yes yes no
rxvt yes no yes bold/black yes no
dtterm yes yes yes reverse yes yes
teraterm reverse no yes rev/red yes no
aixterm normal no yes no yes yes
PuTTY color no yes no yes no
Windows no no no no yes no
Cygwin SSH yes no color color color yes
Mac Terminal yes no yes yes yes yes

Overrides

Terminal colour detection can be disabled or enabled in several ways.

In order of precedence:

  1. Calling colored or cprint with a truthy no_color disables colour.
  2. Calling colored or cprint with a truthy force_color forces colour.
  3. Setting the ANSI_COLORS_DISABLED environment variable to any non-empty value disables colour.
  4. Setting the NO_COLOR environment variable to any non-empty value disables colour.
  5. Setting the FORCE_COLOR environment variable to any non-empty value forces colour.
  6. Setting the TERM environment variable to dumb, or using such a dumb terminal, disables colour.
  7. Finally, termcolor will attempt to detect whether the terminal supports colour.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for hugovk from gravatar.com hugovk

Unverified details

These details have not been verified by PyPI
Meta
  • License Expression: MIT
    SPDX License Expression
  • Author: Konstantin Lepa
  • Maintainer: Hugo van Kemenade
  • Tags ANSI, ANSI color, ANSI colour, color, colour, formatting, termcolor, terminal
  • Requires: Python >=3.9
  • Provides-Extra: tests
Classifiers

Release history Release notifications | RSS feed

This version

3.1.0

3.0.1

3.0.0

2.5.0

2.4.0

2.3.0

2.2.0

2.1.1

2.1.0

2.0.1

2.0.0

1.1.0

1.0.1

1.0.0

0.2

0.1.2

0.1.1

0.1

Download files

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

Source Distribution

termcolor-3.1.0.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

termcolor-3.1.0-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file termcolor-3.1.0.tar.gz.

File metadata

  • Download URL: termcolor-3.1.0.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for termcolor-3.1.0.tar.gz
Algorithm Hash digest
SHA256 6a6dd7fbee581909eeec6a756cff1d7f7c376063b14e4a298dc4980309e55970
MD5 877fe6650412d9cea0384600870f0161
BLAKE2b-256 ca6c3d75c196ac07ac8749600b60b03f4f6094d54e132c4d94ebac6ee0e0add0

See more details on using hashes here.

Provenance

The following attestation bundles were made for termcolor-3.1.0.tar.gz:

Publisher: deploy.yml on termcolor/termcolor

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

File details

Details for the file termcolor-3.1.0-py3-none-any.whl.

File metadata

  • Download URL: termcolor-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for termcolor-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 591dd26b5c2ce03b9e43f391264626557873ce1d379019786f99b0c2bee140aa
MD5 9032fa9b8e95d0026ae14934b368f6fb
BLAKE2b-256 4fbdde8d508070629b6d84a30d01d57e4a65c69aa7f5abe7560b8fad3b50ea59

See more details on using hashes here.

Provenance

The following attestation bundles were made for termcolor-3.1.0-py3-none-any.whl:

Publisher: deploy.yml on termcolor/termcolor

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

Supported by

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