nyshadhr9 / fontbakery

Well designed Font QA tool, written in Python 3

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

For full developer documentation, check out font-bakery.readthedocs.io

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 [email protected] and Lasse Fister [email protected] 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/source/developer/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.