Skip to main content

ansipants

A Python module and command-line utility for converting .ANS format ANSI art to HTML.

Installation

pip install ansipants

Command-line usage

python -m ansipants input.ans > output.html

For additional options, run python -m ansipants --help.

The output is a fragment of HTML, in UTF-8 encoding, intended to be inserted into a preformatted text element (<pre>...</pre>). Further styling is up to you - for the proper MS-DOS experience, The Ultimate Oldschool PC Font Pack by VileR is recommended.

Python API

Example code:

from ansipants import ANSIDecoder

with open('input.ans', 'rt', encoding='cp437') as f:
    decoder = ANSIDecoder(f)

print(decoder.as_html())

class ansipants.ANSIDecoder(stream=None, palette='vga', width=80, strict=False)

Parameters:

  • stream - the ANSI input data as a file-like object. This should be opened for reading in text mode, which means you'll need to specify the appropriate encoding - for ANSI art created for DOS this will most likely be cp437.
  • palette - the colour palette to use; either 'vga' or 'workbench'
  • width - the number of columns the text should wrap at
  • strict - If True, the decoder will raise an ansipants.ANSIDecodeError exception on any unrecognised or malformed escape codes; if False, it will skip past them.

ANSIDecoder.as_html()

Returns the HTML output as a string.

ANSIDecoder.as_html_lines()

Returns the HTML output as an iterator, yielding one line at a time.

Author

Matt Westcott matt@west.co.tt

Release files for ansipants 0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ansipants 0.2
File Size Uploaded
ansipants-0.2.tar.gz 6.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ansipants 0.2
File Interpreter ABI Platform
ansipants-0.2-py3-none-any.whl Python 3 none any Details

Total release size: 13.1 kB

Release files / ansipants-0.2.tar.gz

Download URL ansipants-0.2.tar.gz
Size 6.5 kB
Tags Source
SHA-256 checksum
How to use checksums
9ae78c7499736addf9e8f36db960ff99a96750ba4adff9d0eac10e598bebd1b3
BLAKE2b-256 checksum
How to use checksums
7b05a7426de91fb305d3eb3295d711a3b575d15dd6fbe09fe23ade46bbff73b1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.0

Release files / ansipants-0.2-py3-none-any.whl

Download URL ansipants-0.2-py3-none-any.whl
Size 6.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c634504122a23846969ec51bb5991455e87f33043c9765ea5324277a0dd3ba1d
BLAKE2b-256 checksum
How to use checksums
5f6a95a9c210791e9493113b0b1795c1f3c40460d253d3ecb82ac572fd9028bc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.0

Release history Release notifications | RSS feed

This release

0.2 This release

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page