Skip to main content

Well designed Font QA tool, written in Python 3

Project description

Latest PyPI Version Python [Build Status License: Apache 2.0

Font Bakery

Font Bakery is a command-line tool for checking the quality of font projects.

For a quick overview, check out the list of checks currently offered.

And for a full introduction check out our documentation at Read The Docs.

A recording of the ATypI 2020 FontBakery presentation is also available.

Font Bakery has an active community of contributors from foundries around the world, including Adobe Fonts, Dalton Maag, Type Network, and Google Fonts. Please join our developer chat channel at https://gitter.im/fontbakery/Lobby

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

Run Font Bakery automatically on Github Actions

Simon Cozens prepared a template git repo that makes it easy to build, check and proof fonts. He's also prepared a nice 1 minute video showcasing it.

License

Font Bakery is available under the Apache 2.0 license.

Install

See the Font Bakery Installation Guide for your platform:

Usage

Font Bakery is primarily a Terminal app, learn more in the Command Line Usage Guide.

If you write little Python scripts in your workflow, you can easily write custom checks.

For full developer documentation, check out font-bakery.readthedocs.io (a hosted and compiled copy of contents in the /docs directory.)

Contributing

See the guide to Getting Started as a Contributor.

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 and its presentation deck.

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

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.

Trivia

Project details


Release history Release notifications | RSS feed

This version

0.8.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fontbakery-0.8.2.tar.gz (31.2 MB view hashes)

Uploaded Source

Built Distribution

fontbakery-0.8.2-py2.py3-none-any.whl (293.8 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page