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 written introduction check out our documentation at Read The Docs.

For video introductions, see the TypeCon 2018 and ATypI 2020 FontBakery presentations.

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 gitter.im/fontbakery/Lobby

Font Bakery is not an official Google project, and Google provides no support for it. However, throughout 2018-2023 a project maintainer, Felipe Corrêa da Silva Sanches (@felipesanches), is commissioned by the Google Fonts team to maintain it. The original software architecture (and maintenance of it) is by Lasse Fister (@graphicore.

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.

All comments on the issue tracker or on pull requests will be treated as also licensed under this license such that they can be incorporated into the project code.

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

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.12a1.tar.gz (46.3 MB view details)

Uploaded Source

Built Distribution

fontbakery-0.8.12a1-py3-none-any.whl (340.4 kB view details)

Uploaded Python 3

File details

Details for the file fontbakery-0.8.12a1.tar.gz.

File metadata

  • Download URL: fontbakery-0.8.12a1.tar.gz
  • Upload date:
  • Size: 46.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for fontbakery-0.8.12a1.tar.gz
Algorithm Hash digest
SHA256 b97cc1920fbe019bc81826cfef418e7396f1b626b6e186fb5e8d4981bc0ecf67
MD5 da0de70e579810649f6bcfe3194b3212
BLAKE2b-256 ace6981325a01f288a284ebd3c751bd18dba328cf4aad51d935702cd5e1b56d9

See more details on using hashes here.

Provenance

File details

Details for the file fontbakery-0.8.12a1-py3-none-any.whl.

File metadata

File hashes

Hashes for fontbakery-0.8.12a1-py3-none-any.whl
Algorithm Hash digest
SHA256 87974acb4bac3966140110af8cc1703af082950c9bd73d012316948d4523a289
MD5 c83fc6964e4a4b0ea7a2b3990d930fd0
BLAKE2b-256 2558d1b6324d7aeaaa6ae813c556e76b878165ad67c6cdb32eb411933f0ab44e

See more details on using hashes here.

Provenance

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