termcolor

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)

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`

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:

Calling colored or cprint with a truthy no_color disables colour.
Calling colored or cprint with a truthy force_color forces colour.
Setting the ANSI_COLORS_DISABLED environment variable to any value disables colour.
Setting the NO_COLOR environment variable to any value disables colour.
Setting the FORCE_COLOR environment variable to any value forces colour.
Setting the TERM environment variable to dumb, or using such a dumb terminal, disables colour.
Finally, termcolor will attempt to detect whether the terminal supports colour.

Release files for termcolor 2.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for termcolor 2.5.0
File	Size	Uploaded
termcolor-2.5.0.tar.gz	13.1 kB	Oct 6, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for termcolor 2.5.0
File	Interpreter	ABI	Platform	Reset
termcolor-2.5.0-py3-none-any.whl 7.8 kB Oct 6, 2024	Python 3	none	any	Details

Total release size: 20.8 kB

Release files / termcolor-2.5.0.tar.gz

Download URL	termcolor-2.5.0.tar.gz
Size	13.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`998d8d27da6d48442e8e1f016119076b690d962507531df4890fcd2db2ef8a6f`
BLAKE2b-256 checksum How to use checksums	`377288311445fd44c455c7d553e61f95412cf89054308a1aa2434ab835075fc5`
Upload date	Oct 6, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.1.1 CPython/3.12.7`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/termcolor/termcolor
Publishing commit: github.com/termcolor/termcolor/tree/2654f7f2ae120aa2be69414d161867ec6ebf6f0a

Workflow

Publishing configuration: github.com/termcolor/termcolor/blob/2654f7f2ae120aa2be69414d161867ec6ebf6f0a/.github/workflows/deploy.yml
Publishing logs: github.com/termcolor/termcolor/actions/runs/11204702752/attempts/1

Artifact

Subject: termcolor-2.5.0.tar.gz
SHA-256 checksum: 998d8d27da6d48442e8e1f016119076b690d962507531df4890fcd2db2ef8a6f Verifying attestations

Release files / termcolor-2.5.0-py3-none-any.whl

Download URL	termcolor-2.5.0-py3-none-any.whl
Size	7.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`37b17b5fc1e604945c2642c872a3764b5d547a48009871aea3edd3afa180afb8`
BLAKE2b-256 checksum How to use checksums	`7fbedf630c387a0a054815d60be6a97eb4e8f17385d5d6fe660e1c02750062b4`
Upload date	Oct 6, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.1.1 CPython/3.12.7`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/termcolor/termcolor
Publishing commit: github.com/termcolor/termcolor/tree/2654f7f2ae120aa2be69414d161867ec6ebf6f0a

Workflow

Publishing configuration: github.com/termcolor/termcolor/blob/2654f7f2ae120aa2be69414d161867ec6ebf6f0a/.github/workflows/deploy.yml
Publishing logs: github.com/termcolor/termcolor/actions/runs/11204702752/attempts/1

Artifact

Subject: termcolor-2.5.0-py3-none-any.whl
SHA-256 checksum: 37b17b5fc1e604945c2642c872a3764b5d547a48009871aea3edd3afa180afb8 Verifying attestations