144 lines
6.0 KiB
Plaintext
144 lines
6.0 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: termcolor
|
|
Version: 2.4.0
|
|
Summary: ANSI color formatting for output in terminal
|
|
Project-URL: Changelog, https://github.com/termcolor/termcolor/releases
|
|
Project-URL: Homepage, https://github.com/termcolor/termcolor
|
|
Project-URL: Source, https://github.com/termcolor/termcolor
|
|
Author-email: Konstantin Lepa <konstantin.lepa@gmail.com>
|
|
Maintainer: Hugo van Kemenade
|
|
License: MIT
|
|
License-File: COPYING.txt
|
|
Keywords: ANSI,ANSI color,ANSI colour,color,colour,formatting,termcolor,terminal
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Environment :: Console
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: 3.12
|
|
Classifier: Programming Language :: Python :: 3.13
|
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
Classifier: Topic :: Terminals
|
|
Requires-Python: >=3.8
|
|
Provides-Extra: tests
|
|
Requires-Dist: pytest; extra == 'tests'
|
|
Requires-Dist: pytest-cov; extra == 'tests'
|
|
Description-Content-Type: text/markdown
|
|
|
|
# termcolor
|
|
|
|
[](https://pypi.org/project/termcolor)
|
|
[](https://pypi.org/project/termcolor)
|
|
[](https://pypistats.org/packages/termcolor)
|
|
[](https://github.com/termcolor/termcolor/actions)
|
|
[](https://codecov.io/gh/termcolor/termcolor)
|
|
[](COPYING.txt)
|
|
[](https://github.com/psf/black)
|
|
[](https://tidelift.com/subscription/pkg/pypi-termcolor?utm_source=pypi-termcolor&utm_medium=referral&utm_campaign=readme)
|
|
|
|
## Installation
|
|
|
|
### From PyPI
|
|
|
|
```bash
|
|
python3 -m pip install --upgrade termcolor
|
|
```
|
|
|
|
### From source
|
|
|
|
```bash
|
|
git clone https://github.com/termcolor/termcolor
|
|
cd termcolor
|
|
python3 -m pip install .
|
|
```
|
|
|
|
### Demo
|
|
|
|
To see demo output, run:
|
|
|
|
```bash
|
|
python3 -m termcolor
|
|
```
|
|
|
|
## Example
|
|
|
|
```python
|
|
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` | |
|
|
| `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:
|
|
|
|
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 value disables colour.
|
|
4. Setting the [`NO_COLOR`](https://no-color.org/) environment variable to any value
|
|
disables colour.
|
|
5. Setting the [`FORCE_COLOR`](https://force-color.org/) environment variable to any
|
|
value forces colour.
|
|
6. Setting the `TERM` environment variable to `dumb`, or using such a
|
|
[dumb terminal](https://en.wikipedia.org/wiki/Computer_terminal#Character-oriented_terminal),
|
|
disables colour.
|
|
7. Finally, termcolor will attempt to detect whether the terminal supports colour.
|