Font Bakery is a command-line tool for testing font projects, also available as a drag-and-drop web app from fontbakery.appspot.com
It runs checks on TrueType files, and Google Fonts related metadata files.
If you are developing a font project publicly with Github (or a similar host) you can set up a Continuous Integration service (like Travis) to run FontBakery on each commit, so that with each update your files are tested.
Font Bakery is not an official Google project, and Google provides no support for it.
Visit fontbakery.appspot.com and drop 1 to 18 TTF files on the page, and click the "3"
The source code to this web-based user-interface is all in the webapp/ folder.
In order to run it on your own computer, download this source repo and all dependencies for command line usage.
Then run the following commands:
cd webapp
./dev_appserver.py app
Now open http://0.0.0.0:8000 in your browser.
cd ~/path/to/fontproject/
fontbakery-check-ttf.py *.ttf
For more detailed output, run in verbose mode:
fontbakery-check-ttf.py --verbose *.ttf
It may fix some problems, and save *.ttf.fix files in the same directory as the original .ttf files.
The check results will be saved to a file called fontbakery-check-results.json.
For check results in GitHub Markdown syntax you can use --ghm:
fontbakery-check-ttf.py --verbose *.ttf --ghm
If you need to generate a list of all issues in the Google Fonts, you have to have a full checkout of the Google Fonts git repo, and then you can run:
sh test_all_gfonts.sh
(you'll probably have to edit the first 3 lines in the test_all_gfonts.sh script though, as for now the gfonts repo path is hardcoded in there. I may later make it into a command line parameter)
This will create a folder called check_results and it will run fontbakery on every family from the gfonts git repo, thus generating individual per-font-file reports both in json and in ghmarkdown format. The reports are saved in subdirectories that have names of the families.
It took me 80 minutes to run the full test on the repo. And the resulting check_results folder has got 105Mbytes of json & markdown files. To squeeze it all into a unified report you can run:
./fb_summary_report.py
and it will write to stdout.
If you rather prefer to save it to a file you can do something like:
./fb_summary_report.py > gfonts_check_summary.md
This is a project maintainence tool that generate a CONTRIBUTORS.txt file from a repository's git history.
usage: fontbakery-build-contributors.py [-h] folder
positional arguments:
folder source folder which contains git commits
optional arguments:
-h, --help show this help message and exit
usage: fontbakery-build-font2ttf.py [-h] [--with-otf] source [source ...]
positional arguments:
source
optional arguments:
-h, --help show this help message and exit
--with-otf Generate otf file
Calculates the visual weight, width or italic angle of fonts. For width, it just measures the width of how a particular piece of text renders. For weight, it measures the darness of a piece of text. For italic angle it defaults to the italicAngle property of the font. Then it starts a HTTP server and shows you the results, or if you pass --debug then it just prints the values.
usage: fontbakery-build-fontmetadata.py [-h] -f FILES [-d] [-e EXISTING] [-m]
-o OUTPUT
optional arguments:
-h, --help show this help message and exit
-f FILES, --files FILES
The pattern to match for finding ttfs, eg
'folder_with_fonts/*.ttf'.
-d, --debug Debug mode, just print results
-e EXISTING, --existing EXISTING
Path to existing font-metadata.csv
-m, --missingmetadata
Only process fonts for which metadata is not available
yet
-o OUTPUT, --output OUTPUT
CSV data output filename
A FontForge python script for printing bounding boxes to stdout.
usage: fontbakery-check-bbox.py [-h] font
positional arguments:
font Font in OpenType (TTF/OTF) format
optional arguments:
-h, --help show this help message and exit
Runs checks on specified DESCRIPTION file(s)
usage: fontbakery-check-description.py [-h] [--verbose] file [file ...]
positional arguments:
file Test files, can be a list
optional arguments:
-h, --help show this help message and exit
--verbose, -v Verbosity level
Runs checks or tests on specified upstream folder(s)
usage: fontbakery-check-upstream.py [-h] [--verbose] folders [folders ...]
positional arguments:
folders Test folder(s), can be a list
optional arguments:
-h, --help show this help message and exit
--verbose, -v Verbosity level
Fixes TTF NAME table strings to be ascii only
usage: fontbakery-fix-ascii-fontmetadata.py [-h] ttf_font [ttf_font ...]
positional arguments:
ttf_font Font in OpenType (TTF/OTF) format
optional arguments:
-h, --help show this help message and exit
Fixes TTF to have a dummy DSIG table
usage: fontbakery-fix-dsig.py [-h] [--autofix] ttf_font [ttf_font ...]
positional arguments:
ttf_font One or more font files
optional arguments:
-h, --help show this help message and exit
--autofix Apply autofix
Print out family metadata of the fonts
usage: fontbakery-fix-familymetadata.py [-h] [--csv] font [font ...]
positional arguments:
font
optional arguments:
-h, --help show this help message and exit
--csv
Print out fsSelection bitmask of the fonts
usage: fontbakery-fix-fsselection.py [-h] [--csv] [--autofix] font [font ...]
positional arguments:
font
optional arguments:
-h, --help show this help message and exit
--csv
--autofix
Fixes TTF GASP table
usage: fontbakery-fix-gasp.py [-h] [--autofix] [--set SET]
ttf_font [ttf_font ...]
positional arguments:
ttf_font Font in OpenType (TTF/OTF) format
optional arguments:
-h, --help show this help message and exit
--autofix Apply autofix
--set SET Change gasprange value of key 0xFFFF to a new value
Fixes TTF unencoded glyphs to have Private Use Area encodings
usage: fontbakery-fix-glyph-private-encoding.py [-h] [--autofix]
ttf_font [ttf_font ...]
positional arguments:
ttf_font Font in OpenType (TTF/OTF) format
optional arguments:
-h, --help show this help message and exit
--autofix Apply autofix. Otherwise just check if there are unencoded
glyphs
Report issues on .glyphs font files
usage: fontbakery-fix-glyphs.py [-h] font [font ...]
positional arguments:
font
optional arguments:
-h, --help show this help message and exit
Print out nameID strings of the fonts
usage: fontbakery-fix-nameids.py [-h] [--autofix] [--csv] [--id ID]
[--platform PLATFORM]
font [font ...]
positional arguments:
font
optional arguments:
-h, --help show this help message and exit
--autofix Apply autofix
--csv Output data in comma-separate-values (CSV) file format
--id ID, -i ID
--platform PLATFORM, -p PLATFORM
Fixes TTF GASP table so that its program contains the minimal recommended instructions
usage: fontbakery-fix-nonhinting.py [-h] fontfile_in fontfile_out
positional arguments:
fontfile_in Font in OpenType (TTF/OTF) format
fontfile_out Filename for the output
optional arguments:
-h, --help show this help message and exit
Fixes TTF Autohint table
usage: fontbakery-fix-ttfautohint.py [-h] ttf_font [ttf_font ...]
positional arguments:
ttf_font Font in OpenType (TTF/OTF) format
optional arguments:
-h, --help show this help message and exit
Print vendorID of TTF files
usage: fontbakery-fix-vendorid.py [-h] arg_filepaths [arg_filepaths ...]
positional arguments:
arg_filepaths font file path(s) to check. Wildcards like *.ttf are allowed.
optional arguments:
-h, --help show this help message and exit
usage: fontbakery-fix-vertical-metrics.py [-h] [-a ASCENTS] [-ah ASCENTS_HHEA]
[-at ASCENTS_TYPO] [-aw ASCENTS_WIN]
[-d DESCENTS] [-dh DESCENTS_HHEA]
[-dt DESCENTS_TYPO]
[-dw DESCENTS_WIN] [-l LINEGAPS]
[-lh LINEGAPS_HHEA]
[-lt LINEGAPS_TYPO]
ttf_font [ttf_font ...]
positional arguments:
ttf_font Font file in OpenType (TTF/OTF) format
optional arguments:
-h, --help show this help message and exit
-a ASCENTS, --ascents ASCENTS
Set new ascents value.
-ah ASCENTS_HHEA, --ascents-hhea ASCENTS_HHEA
Set new ascents value in 'Horizontal Header' table
('hhea'). This argument cancels --ascents.
-at ASCENTS_TYPO, --ascents-typo ASCENTS_TYPO
Set new ascents value in 'Horizontal Header' table
('OS/2'). This argument cancels --ascents.
-aw ASCENTS_WIN, --ascents-win ASCENTS_WIN
Set new ascents value in 'Horizontal Header' table
('OS/2.Win'). This argument cancels --ascents.
-d DESCENTS, --descents DESCENTS
Set new descents value.
-dh DESCENTS_HHEA, --descents-hhea DESCENTS_HHEA
Set new descents value in 'Horizontal Header' table
('hhea'). This argument cancels --descents.
-dt DESCENTS_TYPO, --descents-typo DESCENTS_TYPO
Set new descents value in 'Horizontal Header' table
('OS/2'). This argument cancels --descents.
-dw DESCENTS_WIN, --descents-win DESCENTS_WIN
Set new descents value in 'Horizontal Header' table
('OS/2.Win'). This argument cancels --descents.
-l LINEGAPS, --linegaps LINEGAPS
Set new linegaps value.
-lh LINEGAPS_HHEA, --linegaps-hhea LINEGAPS_HHEA
Set new linegaps value in 'Horizontal Header' table
('hhea')
-lt LINEGAPS_TYPO, --linegaps-typo LINEGAPS_TYPO
Set new linegaps value in 'Horizontal Header' table
('OS/2')
Print out Panose of the fonts
usage: fontbakery-list-panose.py [-h] [--csv] font [font ...]
positional arguments:
font
optional arguments:
-h, --help show this help message and exit
--csv
Print out usWeightClass of the fonts
usage: fontbakery-list-weightclass.py [-h] [--csv] font [font ...]
positional arguments:
font
optional arguments:
-h, --help show this help message and exit
--csv
Print out usWidthClass of the fonts
usage: fontbakery-list-widthclass.py [-h] [--csv] [--set SET] [--autofix]
font [font ...]
positional arguments:
font
optional arguments:
-h, --help show this help message and exit
--csv
--set SET
--autofix
usage: fontbakery-metadata-vs-api.py [-h] [--cache CACHE] [--verbose]
[--ignore-copy-existing-ttf] [--autofix]
[--api API]
key repo
positional arguments:
key Key from Google Fonts Developer API
repo Directory tree that contains directories with
METADATA.pb files
optional arguments:
-h, --help show this help message and exit
--cache CACHE Directory to store a copy of the files in the fonts
developer api
--verbose Print additional information
--ignore-copy-existing-ttf
--autofix Apply automatic fixes to files
--api API Domain string to use to request
Compare TTF files when upgrading families.
usage: fontbakery-update-families.py [-h] [-v]
arg_filepaths [arg_filepaths ...]
positional arguments:
arg_filepaths font file path(s) to check. Wildcards like *.ttf are
allowed.
optional arguments:
-h, --help show this help message and exit
-v, --verbose increase output verbosity
# install os x developer tools and the homebrew package manager
xcode-select --install;
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)";
# install ots
brew tap davelab6/webfonttools;
brew update;
brew install ots --HEAD;
# install fontforge
brew install python giflib libspiro icu4c;
brew install fontforge --with-extra-tools --HEAD ;
# install fonttools
easy_install pip;
pip install --upgrade git+https://github.com/behdad/fontTools.git;
# install python dependencies
pip install -r requirements.txt
# install pyfontaine
CFLAGS=-I/usr/local/opt/icu4c/include LDFLAGS=-L/usr/local/opt/icu4c/lib pip install pyicu;
pip install --upgrade git+https://github.com/davelab6/pyfontaine.git;
# install travis, for setting up CI
sudo gem install travis; # fontbakery dependencies
# install fontbakery
pip install --upgrade git+https://github.com/googlefonts/fontbakery.git;# install fontforge
sudo add-apt-repository --yes ppa:fontforge/fontforge;
sudo apt-get update -qq;
sudo apt-get install python-fontforge
# install pyfontaine
sudo apt-get install libicu-dev git;
sudo pip install pyicu;
pip install --upgrade git+https://github.com/davelab6/pyfontaine.git;
# install ots from source
git clone https://github.com/khaledhosny/ots.git;
cd ots;
./autogen.sh;
./configure;
make CXXFLAGS=-DOTS_DEBUG;
sudo make install;
cd ..;
rm -rf ots;
# install fonttools
pip install --upgrade git+https://github.com/behdad/fontTools.git;
# install python dependencies
pip install -r requirements.txt
# install fontbakery
pip install --upgrade git+https://github.com/googlefonts/fontbakery.git;