Well designed Font QA tool, written in Python 3
C Python C++ PureBasic XSLT Shell Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Update ISSUE_TEMPLATE.md Jun 5, 2017
Lib/fontbakery Type-annotate _exec_check arguments Aug 18, 2018
data add good and bad variable-font filenames on code-test for Jun 28, 2018
docs Create variable-fonts-levels.md Aug 7, 2018
prebuilt add ftxvalidator helper script that allows the tool to be Jul 15, 2018
snippets Add files modified by end-of-file-fixer Jun 4, 2018
tests deprecate fonts.google.com/check/080 Aug 14, 2018
.coveragerc Coverage: Pick up .tox*/ subdirectories Apr 18, 2018
.editorconfig Editorconfig: trim trailing whitespace Apr 20, 2018
.gitignore Add --version command line switch Aug 2, 2018
.pre-commit-config.yaml Update pre-commit hooks Jul 23, 2018
.travis.yml bring back filtering of when a travis build must run Aug 15, 2018
AUTHORS.txt Replaced old fontbakery website with fontbakery-cli contents #461 Oct 22, 2014
CHANGELOG.md version 0.5.0 changelog Aug 1, 2018
CONTRIBUTING.md Add files modified by end-of-file-fixer Jun 4, 2018
CONTRIBUTORS.txt adding a few scripts that were missing on setup.py Jul 3, 2017
INSTALL.md [INSTALL.md] include macOS >= 10.13 for ftxvalidator install docs Aug 3, 2018
LICENSE.txt Adding full text of the Apache 2.0 License to LICENSE.txt Jul 16, 2013
MANIFEST.in Move left-over scripts in bin/ to snippets/ Apr 6, 2018
README.md Update README.md Aug 13, 2018
requirements.txt [requirements.txt] bump protobuf version to 3.4.0 Nov 16, 2017
setup.cfg Flake8: ignore line-too-long if <= 10% over Apr 20, 2018
setup.py Add --version command line switch Aug 2, 2018
tox.ini Drop support for Python 2.7 Jul 23, 2018

README.md

Latest PyPI Version Python Travis Build Status License: Apache 2.0

Font Bakery

Font Bakery is a command-line tool for checking the quality of font projects. It currently comes with checks for OpenType files, at 3 levels: Format specifications, distributor requirements, and custom checks.

For a full introduction, check out the Typecon 2018 presentation deck

Font Bakery has an active community of contributors from foundries around the world, including Adobe Typekit, Dalton Maag, Type Network, and Google Fonts.

Font Bakery is not an official Google project, and Google provides no support for it. However, throughout 2018 the project maintainers Felipe Corrêa da Silva Sanches juca@members.fsf.org and Lasse Fister commander@graphicore.de were funded by the Google Fonts team.

Font Bakery is available under the Apache 2.0 license.

Install

See INSTALL.md

Usage

See docs/USAGE.md

Web Dashboard

A web dashboard for monitoring check-results of project collections is at https://github.com/googlefonts/fontbakery-dashboard

History

The project was initiated by Dave Crossland in 2013 to accelerate the onboarding process for Google Fonts. In 2017 Lasse Fister and Felipe Sanches rewrote it into a modern, modular architecture suitable for both individuals and large distributors. Felipe has maintained the check contents since 2016.

Lasse also began a sister project, Font Bakery Dashboard: A UI and a cloud system that scales up for checking 1,000s of font files super fast and in parallel, by using 1,000s of "container" virtual machines. See his TypoLabs 2018 talk on YouTube.

Most of the checks are for OpenType binary files, and project metadata files. (Currently, the Google Fonts METADATA.pb files are supported.)

To learn more about writing custom checks, see docs/writing-specifications.md

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 Font Bakery on each commit, so that with each update all checks will be run on your files.