Font Bakery

1.1.0 verified Fri May 01 auth: no python

Font Bakery is a font quality assurance tool for everyone. It runs a comprehensive suite of automated checks on font files to ensure they meet quality standards, best practices, and specification compliance. Version 1.1.0, released periodically with improvements and new checks.

pip install fontbakery

Common errors

error ModuleNotFoundError: No module named 'fontbakery' ↓

cause Font Bakery not installed or installed in wrong environment.

fix

Run 'pip install fontbakery' in the correct Python environment (Python 3.9+).

error fontbakery.exceptions.CheckExecutionError ↓

cause A check failed during execution, often due to missing dependencies or broken font.

fix

Check the full traceback. Ensure harfbuzz and other system dependencies are installed. Try running 'fontbakery check --verbose'.

error ValueError: A font file is required ↓

cause The command was invoked without specifying a font file or directory.

fix

Provide a path: 'fontbakery check myfont.ttf'

Warnings

breaking Font Bakery 1.0.0 dropped support for Python 3.8 and earlier. Ensure your environment uses Python 3.9+. ↓

fix Upgrade Python to 3.9 or later.

deprecated The '--checks' CLI option has been deprecated in favor of '--exclude' in some versions. Check the help for the correct flags. ↓

fix Use 'fontbakery check --help' to see current options.

gotcha Running checks on a directory of fonts is not recursive by default; you must specify '--recursive' or '--glob'. ↓

fix Use 'fontbakery check --recursive ./fonts/'.

Imports

check
wrong
```
from fontbakery import check
```
correct
```
from fontbakery.api import check
```
Direct import from fontbakery may not work; use fontbakery.api.
FontBakeryCheck
```
from fontbakery.checkrunner import FontBakeryCheck
```
Correct import path for the check class.

Quickstart

Basic usage: run all checks on a font file and print summary.

from fontbakery.api import check
from fontbakery.checkrunner import FontBakeryCheck

# Run all checks on a font file
result = check('path/to/font.ttf')
print(result.summary())