pyfiglet: Pure-Python FIGlet Implementation

Warnings

• breaking Versions 1.0.0 and above drop support for Python versions older than 3.9. If you need Python <= 3.7 support, you must use `pyfiglet<1`. Version 1.0.0 was initially yanked due to compatibility issues with older Python versions. [3]
  Fix: Ensure your Python environment is 3.9 or newer. For older Python versions, explicitly install `pyfiglet<1`.
• gotcha Some fonts that were previously available in older `pyfiglet` distributions (or the original C `FIGlet`) have been removed due to distribution rights. Users expecting specific fonts might find them missing. [1, 5]
  Fix: If a desired font is missing, search for 'figlet fonts' online. Some external fonts can be loaded via the command line interface: `pyfiglet -L <font_file>`. [1]
• gotcha When bundling applications with PyInstaller, `pyfiglet` fonts might not be automatically included, leading to `ModuleNotFoundError: No module named 'pyfiglet.fonts'` errors at runtime. [15]
  Fix: Use the `--collect-all pyfiglet` option with PyInstaller (e.g., `pyinstaller -F --collect-all pyfiglet your_script.py`). [15]
• gotcha The internal code for kerning, mushing, and rendering is described as "fragile and complex." While this primarily affects contributors modifying the core logic, it suggests potential for unexpected behavior with highly customized inputs or unusual fonts. [1, 5, 8]
  Fix: For complex or custom rendering scenarios, thorough testing of the output is recommended.
• gotcha An open issue indicates potential incompatibility where `pyfiglet` might break with `setuptools >= 82`. This could lead to installation or runtime errors in environments with newer `setuptools` versions. [14]
  Fix: Monitor the GitHub issue tracker for a resolution. If encountered, try pinning an older `setuptools` version or isolating `pyfiglet` in a dedicated virtual environment.

Install

• pip install pyfiglet Install latest version

Imports

• figlet_format

  import pyfiglet
  result = pyfiglet.figlet_format("Hello")

  While a 'Figlet' class exists, the `pyfiglet.figlet_format` function is the most common and direct way to render text, as shown in most examples. The `Figlet` class might be for more advanced or older use cases. [1, 2, 6, 10]

Quickstart

This quickstart demonstrates how to use `pyfiglet.figlet_format` to convert a string into ASCII art using either the default font or a specified font. It also includes an optional snippet to list all available fonts. [2, 4, 6]

import pyfiglet

# Render text using the default font
text_default = pyfiglet.figlet_format("Hello, World!")
print(text_default)

# Render text using a specific font (e.g., 'slant')
text_slant = pyfiglet.figlet_format("Pyfiglet", font="slant")
print(text_slant)

# List available fonts (optional)
# Uncomment to see a long list
# fig = pyfiglet.Figlet()
# print(fig.getFonts())