Skip to main content

change color and style (bold, reverse) of text on display

Project description

ansiterm Package

ansiterm - change color and style (bold, reverse) of text on display

DESCRIPTION

This manual page documents ansiterm module, a Python module providing functions for generating ANSI escape sequences to change the color and the style (i.e., bold and reverse) of text displayed on the screen.

A majority of terminal emulators support ANSI escape sequences. ansiterm module provides handy functions for changing the color and the style.

Please refer to https://en.wikipedia.org/wiki/ANSI_escape_code for the introduction of ANSI escape sequences.

EXAMPLE

from ansiterm import color

for bold in (False, True):
    for reverse in (False, True):
        for name in [
                'reset', 'bold', 'underline', 'reverse', 'gray', 'red',
                'green', 'yellow', 'blue', 'magenta', 'cyan', 'white'
        ]:
            astr = color('text in {} with bold={}, reverse={}'.format(
                name, bold, reverse),
                         name,
                         bold=bold,
                         reverse=reverse)
            print(astr)

FUNCTIONS

ansiterm module provides the following functions.

  • color(astr, name='bold', bold=False, reverse=False)

    Embed ANSI escape sequences around string ASTR to change the text style to NAME. Make the text boldface and reversed video if BOLD or REVERSE is True, respectively.

The following functions are provided as short-cuts. For instance, blue(astr) and reest(astr) are equivalent to color(astr, 'blue') and color(astr, 'reset), respectively.

  • reset(astr, bold=False, reverse=False)

  • bold(astr, bold=True, reverse=False)

  • gray(astr, bold=False, reverse=False)

  • red(astr, bold=False, reverse=False)

  • green(astr, bold=False, reverse=False)

  • yellow(astr, bold=False, reverse=False)

  • blue(astr, bold=False, reverse=False)

  • magenta(astr, bold=False, reverse=False)

  • cyan(astr, bold=False, reverse=False)

  • white(astr, bold=False, reverse=False)

INSTALLATION

pip3 install ansiterm

AVAILABILITY

The latest version of ansiterm module is available at PyPI (https://pypi.org/project/ansiterm/) .

SEE ALSO

perl(1), perlfunc(1), getopt(3), Getopt::Std(3perl)

AUTHOR

Hiroyuki Ohsaki <ohsaki[atmark]lsnl.jp>

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

ansiterm-1.1.tar.gz (3.0 kB view details)

Uploaded Source

Built Distribution

ansiterm-1.1-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file ansiterm-1.1.tar.gz.

File metadata

  • Download URL: ansiterm-1.1.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for ansiterm-1.1.tar.gz
Algorithm Hash digest
SHA256 b063cdcc3711706452f489ef5817f97a32407a9006f60006267096dced00e48f
MD5 3e64470bc88f4bfd94384e2b5e305c73
BLAKE2b-256 c69782085a3c4676c6da8097c96002f41f6b9c0761d1dcdb980b19111c56636a

See more details on using hashes here.

File details

Details for the file ansiterm-1.1-py3-none-any.whl.

File metadata

  • Download URL: ansiterm-1.1-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for ansiterm-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6258baabc93dbb5efbbd281e7ffc294c58cad27d47a93e5a306b6c8f83842cd8
MD5 38dc82ad134913aeb30b4d32e6d0a0da
BLAKE2b-256 6a31fa2673d1ff21a313b4f6d99a19b83dec2d51e2f88395e03d17aa21fd81d8

See more details on using hashes here.

Supported by

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