Rich-Pyfiglet

Rich-PyFiglet is an implementation of PyFiglet for Rich.

This is both a library and a CLI tool. The library provides a RichFiglet class that is fully compatible with the Rich API and can be dropped into your Rich scripts. It also includes a CLI that can be used as part of shell scripts or to quickly test out different settings.

This library is related to Textual-Pyfiglet.

Features

• Usage in your Rich scripts can be a single line of code with default settings.
• Color system built on Rich can take common formats such as hex code and RGB, as well as a big list of named colors.
• Banner will automatically adjust to the terminal width and word-wrap the text.
• Automatically create gradients between colors vertically or horizontally.
• Comes with 4 animation modes built in (up, down, smooth-strobe, fast-strobe).
• Pass in a list of colors for multicolored gradients and animations.
• Manually tweak the gradient quality as well as the animation FPS in order to customize the banner the way you want it.
• Add borders around the banner - The RichFiglet takes border settings as arguments, which allows it to properly account for the border and padding when calculating its available space (without doing this, some terminal sizes would mess up the render).
• Included CLI mode for shell scripting and quick testing.
• The fonts are type-hinted to give you auto-completion in your code editor.
• Demo script included in the package, check it out using the CLI.

Try out the CLI without Installing

If you have uv or pipx, you can immediately try the included CLI:

uvx rich-pyfiglet 'Rich is awesome' --colors blue:green

pipx run rich-pyfiglet 'Rich is awesome' --colors blue:green

Demo

Try out the demo script included in the package without installing:

uvx rich-pyfiglet demo

pipx run rich-pyfiglet demo

Documentation

Click here for documentation

Questions, Issues, Suggestions?

Use the issues section for bugs, issues, ideas or feature requests.

Thanks and Copyright

Both Rich-Pyfiglet and the original PyFiglet are under MIT License. See LICENSE file.

FIGlet fonts have existed for a long time, and many people have contributed over the years.

Original creators of FIGlet:
https://www.figlet.org

The PyFiglet creators:
https://github.com/pwaller/pyfiglet

Rich:
https://github.com/Textualize/rich

And finally, thanks to the many hundreds of people that contributed to the fonts collection.