An implementation of figlet written in Python

Hello :),

A while ago (nearly a year!), I submitted pyfiglet for inclusion in the Fedora repositories. It was approved, but its inclusion was aborted as I found out about all the fonts included and nearly fainted at the sight of reviewing each of these fonts licenses. In retrospect, I should've contacted you to help me with those issues, which is why I decided to do it now.

Indeed, today @peterbrittain found out by luck of our effort to package pyfiglet and let us know that all the fonts which were not distributable were removed (as per #59). That is great, but unfortunately not enough. Indeed, for Fedora, it is required that the license of each font is documented and shipped with its license. And this package has fonts... A lot of them... And most are undocumented.

I also found out thanks to @peterbrittain that there is prior art in FIGlet licensing in Fedora, and what I seem to take out from that discussion is that if the shape and appearance of the fonts themselves are Public Domain, the files still remain under a font license.

So, what needs to be done is the curation of each font file in this repository. What could also be done is the creation of a new repository containing non-free or lost fonts that users can add easily using pyfiglet -L, while keeping safe fonts in the main repository.

First off, I just wanted to say that I love that you've spent the time to port FIGlet to Python. This is a great project and I want to say thank you for creating it. But that's not why I've raised this issue... :-)

It turns out that many of your dependent projects/packages (https://github.com/pwaller/pyfiglet/network/dependents) are using pyfiglet, but are not redistributing under the terms of the GPL-2.0 license that you are using. My own package (https://github.com/peterbrittain/asciimatics) appears to have fallen foul of this.

I really want to continue to deploy my package under the terms of the Apache-2.0 license, which as I understand it means I have to follow one of the following options:

1. Remove/replace the use of your package
2. Convert all direct use of pyfiglet (via import) into separate process calls (via your command-line script).
3. Agree with you (as the copyright holders) a separate license for my project.
4. Persuade you to change your standard license to something that allows for this use case - e.g. LGPL-3.0.

Given how many other projects depend on this one (and are actually breaking the terms as I now understand them), I'd like to try to do the right thing here and explore options 3 and 4 with you before just diving into options 1 or 2.

So... Would you be willing to consider some other form of licensing like LGPL?

Added carriage return support to pyfiglet refactored the FigletRenderingEngine: Use a Director - Builder - Product design pattern refactored test.py, tests are now easy to add. added a test_font script too diff fonts results with figlet added stats_erroneous_font.py based on test.py, show which font and type of smush value are failing the tests

If the width is smaller than a character width of the font, we throw an exception, get a bigger terminal with more than 6 columns :-) This is different from figlet which will either send many spaces or little part of the characters

Fixes #25.

Please see comments raised by @peterbrittain in https://github.com/pwaller/pyfiglet/issues/58#issuecomment-425883141 #58

In essence, I think we need to revert #46, or come to an understanding that distributing these is legitimate.

Paging @peterbrittain, @stefanor @asakasinsky (#20) @MinchinWeb (#46).

I could use some help figuring out what needs to be done here, I also don't have much free time for actioning this. Here is a quick first pass proposal:

1. Identify fonts which need removing.
   • (or equivalently, which can be kept, so that the code is self standing)
2. Remove them from the github repository.
   • Decode if they need removing from the history of the repository.
3. Remove them from source distributions on PyPi.
   • Decide if they need removing from older versions (if they should be removed from the repository
4. Provide a mechanism for the user to obtain/use additional fonts from sources where the license is valid.

Hopefully this is everything we agreed...

• Fonts now separated out into 2 directories
• Makefule updated to make it easy to build minimal or full font definitions
• Docs updated to say what's happened.

I didn't go for the BDF files in the end as I wasn't so sure about the legality, while the other explicit license text was much more reassuring.

Are we good to go?

pyfiglet-0.6.1 from pip

>>> f = Figlet(dir=fontPath, font='slant')
Traceback (most recent call last):
  File "<console>", line 1, in <module>
TypeError: __init__() got an unexpected keyword argument 'dir'

Hi,

I just implemented this because I needed to use in a project and said, why not?

I added to keyword args into the print_figlet method

I also created a dictionary for storing the ASCII codes of the colors, and i created a method that converts the color passed to the escaped sequence

I also added to more params to the optparse, -c and -b

is my first time doing a PR so hope i do it right....

I don't see a sponsor button, so I'm going to at least say

M""""""""M dP                         dP       
Mmmm  mmmM 88                         88       
MMMM  MMMM 88d888b. .d8888b. 88d888b. 88  .dP  
MMMM  MMMM 88'  `88 88'  `88 88'  `88 88888"   
MMMM  MMMM 88    88 88.  .88 88    88 88  `8b. 
MMMM  MMMM dP    dP `88888P8 dP    dP dP   `YP 
MMMMMMMMMM                                     
                                               
M""MMMM""M                   dP 
M. `MM' .M                   88 
MM.    .MM .d8888b. dP    dP 88 
MMMb  dMMM 88'  `88 88    88 dP 
MMMM  MMMM 88.  .88 88.  .88    
MMMM  MMMM `88888P' `88888P' oo 
MMMMMMMMMM

You've made my code so much more enjoyable, fun, and provided the library that my GUI sits on top of. Without your code, there would be no figlets in my code.

Much happier code after finding pyfiglet

Using the colored module, you can access quite many colors available in the terminal.

Is it anyhow possible to confugure pyfiglet to use color settings (as) provided by this module?

In pypy, which is garbage collected rather than refcounted, open file handles can sometimes collect too quickly for the garbage collector and trigger the operating system's file handle limit.

In my test code, I was seeing this failure:

ERROR: Failure: IOError ([Errno 24] Too many open files: u'/Users/llimllib/.virtualenvs/limbopypy/site-packages/pyfiglet/fonts/stellar.flf')
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/llimllib/.virtualenvs/limbopypy/site-packages/nose/loader.py", line 414, in loadTestsFromName
    addr.filename, addr.module)
  File "/Users/llimllib/.virtualenvs/limbopypy/site-packages/nose/importer.py", line 47, in importFromPath
    return self.importFromDir(dir_path, fqname)
  File "/Users/llimllib/.virtualenvs/limbopypy/site-packages/nose/importer.py", line 94, in importFromDir
    mod = load_module(part_fqname, fh, filename, desc)
  File "/Users/llimllib/code/limbo/test/test_plugins/test_banner.py", line 10, in <module>
    from banner import on_message
  File "/Users/llimllib/code/limbo/test/test_plugins/../../limbo/plugins/banner.py", line 9, in <module>
    FONTS = FIGLET.getFonts()
  File "/Users/llimllib/.virtualenvs/limbopypy/site-packages/pyfiglet/__init__.py", line 750, in getFonts
    return self.Font.getFonts()
  File "/Users/llimllib/.virtualenvs/limbopypy/site-packages/pyfiglet/__init__.py", line 119, in getFonts
    if cls.isValidFont(font)]
  File "/Users/llimllib/.virtualenvs/limbopypy/site-packages/pyfiglet/__init__.py", line 111, in isValidFont
    f = pkg_resources.resource_stream('pyfiglet.fonts', font)
  File "/Users/llimllib/.virtualenvs/limbopypy/site-packages/pkg_resources/__init__.py", line 1161, in resource_stream
    self, resource_name
  File "/Users/llimllib/.virtualenvs/limbopypy/site-packages/pkg_resources/__init__.py", line 1715, in get_resource_stream
    return open(self._fn(self.module_path, resource_name), 'rb')
IOError: [Errno 24] Too many open files: u'/Users/llimllib/.virtualenvs/limbopypy/site-packages/pyfiglet/fonts/stellar.flf'

As soon as I patched pyfiglet's getFont method to close the file handle, all my tests passed.

I don't know much about pkg_resources, but the docs promise that the result of resource_stream should be a file-like object, and so .close() should be legal on it.

Maybe trim to 1 newline at front and end?

Happy to work on this. Let me know what you think. Thanks for the project. :)

Example:

➜  /tmp  pyfiglet -f doh 0
                   
                   
     000000000     
   00:::::::::00   
 00:::::::::::::00 
0:::::::000:::::::0
0::::::0   0::::::0
0:::::0     0:::::0
0:::::0     0:::::0
0:::::0 000 0:::::0
0:::::0 000 0:::::0
0:::::0     0:::::0
0:::::0     0:::::0
0::::::0   0::::::0
0:::::::000:::::::0
 00:::::::::::::00 
   00:::::::::00   
     000000000     
                   
                   
                   
                   
                   
                   
                   

➜  /tmp  

I've try to install custom fonts, but the command returns error.

pyfiglet -L ansi_shadow Usage: pyfiglet [options] [text..] pyfiglet: error: no such option: -L

With the font ANSI Regular, the output text lacks spaces between the letters. Which, that goes without saying, makes the text pretty much unreadable. The issue occurs only with pyfiglet and not figlet.

I'm trying to make a calculator, but I need to format different strings with different colors but when I add all the formatted strings together they each appear on a new line. I've been looking through the code for the library but can't find any thing that can help

Any ideas?

I installed pyserial without the pip package manager. I could not get the SSL module to work on my Nvidia Jetson (ubuntu 14), so installing via pip was not an option. Instead, I cloned the repo and installed from the setup script.

This is not an issue when installing via pip on another computer (same python and pip versions).

Here are the commands I used:

git clone https://github.com/pwaller/pyfiglet
cd pyfiglet
sudo python3.7 setup.py install

When I checked out the most recent release tag, it solved the issue. (I deleted the previous version from site-packages)

git clone https://github.com/pwaller/pyfiglet
cd pyfiglet
git checkout d7079e9 # Working version
sudo python3.7 setup.py install

pyfiglet doesn't import. Here's the error:

import pyfiglet

KeyError Traceback (most recent call last) ~\AppData\Local\Temp/ipykernel_17912/2380198760.py in ----> 1 import pyfiglet

C:\JupyterLab\resources\jlab_server\lib\site-packages\pyfiglet_init_.py in 57 58 if sys.platform == 'win32': ---> 59 SHARED_DIRECTORY = os.path.join(os.environ["APPDATA"], "pyfiglet") 60 else: 61 SHARED_DIRECTORY = '/usr/local/share/pyfiglet/'

C:\JupyterLab\resources\jlab_server\lib\os.py in getitem(self, key) 673 except KeyError: 674 # raise KeyError with the original key value --> 675 raise KeyError(key) from None 676 return self.decodevalue(value) 677

KeyError: 'APPDATA'

And here's the contents of os.environ

environ{'HOMEDRIVE': 'C:', 'HOMEPATH': '\Users\mike', 'JUPYTER_CONFIG_DIR': 'C:\Users\mike\AppData\Roaming\jupyterlab-desktop', 'JUPYTER_TOKEN': 'foo(removed)', 'LOGONSERVER': '\\LUNDERVAND', 'PATH': 'C:\JupyterLab\resources\jlab_server;C:\JupyterLab\resources\jlab_server\Library\mingw-w64\bin;C:\JupyterLab\resources\jlab_server\Library\usr\bin;C:\JupyterLab\resources\jlab_server\Library\bin;C:\JupyterLab\resources\jlab_server\Scripts;C:\JupyterLab\resources\jlab_server\bin;C:\Python39\Scripts\;C:\Python39\;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\ProgramData\chocolatey\bin;C:\Program Files\Git\cmd;C:\Program Files\nodejs\;C:\JupyterLab;C:\Users\mike\AppData\Local\Microsoft\WindowsApps;C:\Users\mike\AppData\Local\Programs\Microsoft VS Code\bin;C:\Users\mike\AppData\Roaming\npm', 'SYSTEMDRIVE': 'C:', 'SYSTEMROOT': 'C:\WINDOWS', 'TEMP': 'C:\Users\mike\AppData\Local\Temp', 'USERDOMAIN': 'LUNDERVAND', 'USERNAME': 'mike', 'USERPROFILE': 'C:\Users\mike', 'WINDIR': 'C:\WINDOWS', 'PYDEVD_USE_FRAME_EVAL': 'NO', 'JPY_INTERRUPT_EVENT': '2248', 'IPY_INTERRUPT_EVENT': '2248', 'JPY_PARENT_PID': '1996', 'TERM': 'xterm-color', 'CLICOLOR': '1', 'PAGER': 'cat', 'GIT_PAGER': 'cat', 'MPLBACKEND': 'module://matplotlib_inline.backend_inline'}

And here's the JupyterLab version (standalone / Electron app): Version 3.2.5-1