pyfiglet: Render ASCII Text into ASCII Art Fonts in Python

Introduction

pyfiglet is a comprehensive pure Python port of the classic FIGlet utility, designed to transform standard ASCII text into decorative ASCII art fonts. This project brings the beloved functionality of FIGlet, including its complex kerning and smushing algorithms, directly into the Python ecosystem. It allows developers and users to generate stylized text for various purposes, such as terminal banners, log messages, or creative text displays, without relying on external executables.

Installation

Installing pyfiglet is straightforward using pip, the Python package installer.

To install the library:

pip install pyfiglet

If you wish to install new fonts, you can use the command-line interface:

pyfiglet -L <font file>

The font file can be a ZIP archive containing multiple fonts or a single font file. Depending on your installation, you might need root privileges (e.g., sudo pyfiglet -L <font file>). pyfiglet also automatically detects fonts installed by FIGlet in standard system paths like /usr/local/share/figlet and /usr/share/figlet.

Examples

pyfiglet can be used both as a command-line tool, similar to C figlet, and as a Python library within your code.

Command-line usage:

pyfiglet 'text to render'

You can specify a font using the -f option:

pyfiglet -f slant 'text to render'

As a Python library:

You can use the Figlet class for more control:

from pyfiglet import Figlet
f = Figlet(font='slant')
print(f.renderText('text to render'))

Alternatively, for a simpler approach:

import pyfiglet
f = pyfiglet.figlet_format("text to render", font="slant")
print(f)

Why Use pyfiglet?

• Pure Python Implementation: It's a full port of FIGlet written entirely in Python, eliminating the need for external C binaries or dependencies.
• Seamless Integration: Easily embed dynamic ASCII art rendering directly into your Python applications, scripts, or web services.
• Full FIGlet Feature Parity: It accurately supports advanced FIGlet features like kerning and smushing, ensuring output identical to the original utility.
• Versatile Usage: Provides both a robust command-line interface for quick text transformations and a flexible Python API for programmatic control.
• Active Maintenance: The project is actively maintained, addressing issues and incorporating improvements from a community of contributors.

Links

• GitHub Repository: https://github.com/pwaller/pyfiglet