Skip to main content

A library to produce ansi color output and colored highlighting and diffing

Project description

Python version support: CPython 2.6, 2.7, 3.2, 3.3 and PyPy.


ansicolor is a library that makes it easy to use ansi color markup in command line programs.


$ pip install ansicolor

Getting started

To get some simple color output:

from ansicolor import green
from ansicolor import red
from ansicolor import white

print("Let's try two colors: %s and %s!" % (red("red"), green("green")))
print("It's also easy to produce text in %s," % (red("bold", bold=True)))
print("...%s," % (green("reverse", reverse=True)))
print("...and %s." % (cyan("bold and reverse", bold=True, reverse=True)))

This will emit ansi escapes into the string: one when starting a color, another to reset the color back to the default:

>>> from ansicolor import green

>>> green("green")

If I want to be able to pass a color as an argument I can also use the colorize function:

from ansicolor import Colors
from ansicolor import colorize

print(colorize("I'm blue", Colors.Blue))

I can also apply color on a portion of a string:

from ansicolor import Colors
from ansicolor import wrap_string

print(wrap_string("I'm blue, said the policeman.", 8, Colors.Blue))

Sometimes I may have a string that contains markup and I’ll want to do something with it that concerns only the text, so I can strip the markup:

>>> from ansicolor import red
>>> from ansicolor import strip_escapes
>>> from ansicolor import yellow

>>> message = "My favorite colors are %s and %s" % (yellow("yellow"), red("red"))
>>> print("The length of this string is not: %d" % len(message))
The length of this string is not: 67
>>> print("The length of this string is: %d" % len(strip_escapes(message)))
The length of this string is: 37

Going further

Take a look at the demos to see what’s possible.

$ python -m ansicolor.demos --color
$ python -m ansicolor.demos --highlight
$ python -m ansicolor.demos --diff

Also see the API documentation.

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

ansicolor-0.1.2.tar.gz (5.9 kB view hashes)

Uploaded source

Built Distribution

ansicolor-0.1.2-py2.py3-none-any.whl (6.5 kB view hashes)

Uploaded 2 7

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page