Skip to main content

ANSI codes to HTML converter

Project description

Features

  • It can be used either as module or as a command line tool.

  • Supports most ‘m’ codes (colors and attributes).

  • The apperance can be customized using styles in a very convenient and powerful way.

    • ANSI attributes are mapped to stylable HTML classes (ansi_yellow, ansi_bright…)

    • Text sequences with the same set of ANSI attributes are enclosed in a single span with those classes activated.

    • You can define styles for a class or for a certain combination of classes

    • You can define the style depending on the enclosing container so that different styles can coexist in a single document.

  • It has been test driven developed and back2back tested.

Usage as Python module

  • deansi.styleSheet(): returns the default stylesheet for the ANSI classes you can customize.

  • deansi.deansi(consoleText): returns the HTML conversion

The following example use them to build a simple console look of the output:

import deansi

html_template = """\
<style>
.ansi_terminal {{ background-color: #222; color: #cfc; }}
{defaultStyle}
</style>
<div class="ansi_terminal">{ansiText}</div>
"""
ansiInput = "\033[31mHello World!!\033[m"

print html_template.format(
    defaultStyle = deansi.styleSheet(),
    ansiText = deansi.deansi(ansiInput),
    )

Command line use

deansi can be used as pipe based command line tool. A quite simple use, could be:

$ ls --color | deansi.py > ls.html

Besides, we can use some options to modify its behaviour:

$ deansy.py --help

usage: deansi.py [-h] [-s FILE] [-t FILE] [--dark] [INPUT_FILE] [OUTPUT_FILE]

Converts coloured console output into equivalent HTML

positional arguments:
  INPUT_FILE            the console input to convert (default stdin)
  OUTPUT_FILE           the file where to drop the html output (default
                        stdout)

optional arguments:
  -h, --help            show this help message and exit
  -s FILE, --style FILE
                        use FILE as stylesheet
  -t FILE, --template FILE
                        use FILE as html template
  --dark                use the dark background style

Customizing stylesheets

The default stylesheet looks like this:

.ansi_terminal { background-color: #222; color: #cfc; }
.ansi_terminal { white-space: pre; font-family: monospace; }
.ansi_black { color: black; }
.ansi_red { color: darkred; }
.ansi_green { color: darkgreen; }
.ansi_yellow { color: orange; }
.ansi_blue { color: darkblue; }
.ansi_magenta { color: purple; }
.ansi_cyan { color: darkcyan; }
.ansi_white { color: lightgray; }
.ansi_bright.ansi_black { color: gray; }
.ansi_bright.ansi_red { color: red; }
.ansi_bright.ansi_green { color: green; }
.ansi_bright.ansi_yellow { color: yellow; }
.ansi_bright.ansi_blue { color: blue; }
.ansi_bright.ansi_magenta { color: magenta; }
.ansi_bright.ansi_cyan { color: cyan; }
.ansi_bright.ansi_white { color: white; }
.ansi_bgblack { background-color: black; }
.ansi_bgred { background-color: red; }
.ansi_bggreen { background-color: green; }
.ansi_bgyellow { background-color: yellow; }
.ansi_bgblue { background-color: blue; }
.ansi_bgmagenta { background-color: magenta; }
.ansi_bgcyan { background-color: cyan; }
.ansi_bgwhite { background-color: white; }
.ansi_bright { font-weight: bold; }
.ansi_faint { opacity: .5; }
.ansi_italic { font-style: italic; }
.ansi_underscore { text-decoration: underline; }
.ansi_blink { text-decoration: blink; }
.ansi_reverse { border: 1pt solid; }
.ansi_hide { opacity: 0; }
.ansi_strike { text-decoration: line-through; }

Because of the cascading behaviour of CSS whichever style rules after the default ones, will override those ones. For example if you want to change the yellow color when the ansi bright attribute apply, instead of applying bold font you can say:

.ansi_yellow.ansi_bright { color: #FF7; font-weight: inherit; }

If you want several behaviours in the same html you can use css magic like that:

.my_own_ansi_enviroment .ansi_inverse { font-style: italic; border: none; }

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

deansi-1.1.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

deansi-1.1.linux-i686.tar.gz (7.5 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: deansi-1.1.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for deansi-1.1.tar.gz
Algorithm Hash digest
SHA256 ec80736b4332cc28f5c82e95549f2bea767b4bbe47a4230d9e997d5f1836179c
MD5 bd33c572ab9a94d11207df3c29d1b62a
BLAKE2b-256 e5befe5c7e4f899b7704ff1c69293acc779e5fec230e942d9d119e28da8c46bc

See more details on using hashes here.

File details

Details for the file deansi-1.1.linux-i686.tar.gz.

File metadata

File hashes

Hashes for deansi-1.1.linux-i686.tar.gz
Algorithm Hash digest
SHA256 4a2aa8e4538158450cdee981ee81c29999ff3c60e6fe396a88f28fd3c8f1a8de
MD5 5ff18267b9ba418c158ad16013bc13eb
BLAKE2b-256 d5bc439f56460cdbf8445e306df0706624297e3720253cb45b9f943cb103f0d3

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