Skip to main content

Easily print colored text to the console

Project description

https://travis-ci.org/MisanthropicBit/colorise.svg?branch=master https://pypip.in/license/colorise/badge.png

Provides cross-platform text coloring for consoles, useful functions and a nestable color format syntax.

colorise has been tested with Python 2.6, 2.7, 3.2 and 3.3.

Installation:

You can install via pip:

pip install colorise

Alternatively, if you downloaded the source files, just run the following command from the download directory:

python setup.py install

Usage:

There are a number of ways to color the foreground- and background colors of the output to the console. You can find additional examples in the /examples folder.

You can directly set the color:

Using the set_color function

You can print some text in a predefined color

Using the cprint function to color a string

colorise has a special color format syntax that allows for nested expressions as well:

Print color formatted text

There are a few useful tools as well:

Format a string in colors Format a string in colors using a list of indices

colorise.highlight behaves like colorise.formatbyindex, but will write the output instead of returning a string:

Highlighting select characters in a string

If you have a < or > in your string, you can escape it with a backslash \. The backslash is automatically removed. Colons, escaped or not, : are ignored if they appear as text.

Use of escapes in a color format string

Implementation notes

On Linux and Unix there are no ‘dark’ themed backgrounds (perhaps “bolded” colors which do not truly represnt darkened colors), so calling

>>> colorise.cprint("Isn't this wrong?", bg='darkred')

will just set the background color to red.

Due to the many different termnial/console types, it is virtually impossible to correctly map color names to their actual colors. You may see variations (like ‘yellow’ showing up as brownish, e.g. on my Xubuntu box) or other discrepancies. colorise assumes the following available colors:

  • Black
  • Red
  • Green
  • Yellow
  • Blue
  • Magenta
  • Cyan
  • White

It is therefore best to stick to colors which are more likely to be present and correct, like ‘red’, ‘blue’ and ‘green’.

Project details


Release history Release notifications

This version
History Node

0.1.4

History Node

0.1.3

History Node

0.1.0

History Node

0.0.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
colorise-0.1.4.zip (19.1 kB) Copy SHA256 hash SHA256 Source None Jun 11, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page