More information about dependencies

[elliottslaughter]

Your README currently lists several dependencies, but I can't find any of them (under these names) on PyPI, or even in the Ubuntu package database (for 2 of the 3). Would it be possible to add a more information so that users know which packages you are referring to? Preferably, if any of these package are in PyPI, you would list those package names instead or as well. Otherwise links to the original projects are probably best. (Bonus points if you can provide installation instructions.)

As best I can tell:

• python-fontforge: Is included with FontForge, so what you really need to do here is install FontForge. The ufo2otf project provides instructions:

  debian, ubuntu:

  $ sudo apt-get install fontforge python-fontforge
  

  os x:

  $ brew install fontforge
  

  (https://pypi.python.org/pypi/ufo2otf)

• python-htmlentitydefs: This one isn't in PyPI or Ubuntu's package database. However, on OS X at least, it appears to be pre-installed? At least import htmlentitydefs; htmlentitydefs.__file__ reports something in my /System directory. If this is indeed part of the Python standard distribution, it probably shouldn't be listed, or should at least be explicitly called out as such, since it is very confusing to look for the package and not find anything.

• python-unicodedata: As best I can tell, this is really the unicodedata2 package on PyPI, here: https://pypi.python.org/pypi/unicodedata2/8.0.0 . I don't know what distribution's package name you listed in your README, since again it does not appear under that name in Ubuntu.

Again, I would prefer that if you list package names, that those packages would be consistent with PyPI, since pip is probably the first tool that most people turn to for installing Python packages. However, given that at least one package seems to be unavailable on PyPI, it might be best to just list a brief set of installation instructions, as in:

Ubuntu:

sudo apt-get install fontforge python-fontforge
sudo pip install unicodedata2

OS X:

brew install fontforge
sudo pip install unicodedata2

[pettarin]

You are right, the README is vague.

I plan to fix it in the next release, thank you for providing the actual names.

[pettarin]

I am planning to update glyphIgo to use the shiny new fonttools next week or the following one. While doing that, I will review the documentation too.

[pettarin]

I decided to allocate some time next month (August 2016) to rewrite glyphIgo. This time for real. In that occasion, I will fix the docs too. Meanwhile, I updated the README. Apologies for the iatus.