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.

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.10rc0.tar.gz (39.4 MB view details)

Uploaded Source

Built Distribution

fontbakery-0.8.10rc0-py3-none-any.whl (316.7 kB view details)

Uploaded Python 3

File details

Details for the file fontbakery-0.8.10rc0.tar.gz.

File metadata

  • Download URL: fontbakery-0.8.10rc0.tar.gz
  • Upload date:
  • Size: 39.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for fontbakery-0.8.10rc0.tar.gz
Algorithm Hash digest
SHA256 0e1dbfaeae95a1fadf5e42b193c087f15b809c85e6461792d33b5c6827e29b89
MD5 9d1cd1553e7a3402f0893493678db6d2
BLAKE2b-256 b895979e66ffddecea56f34affdc85d5b5f72f292b40d256ad5ac2834d6ccd00

See more details on using hashes here.

Provenance

File details

Details for the file fontbakery-0.8.10rc0-py3-none-any.whl.

File metadata

File hashes

Hashes for fontbakery-0.8.10rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 51fd2a2cc4fdd0bae0e47a03c06c21b054ea3983478fa9d3eac0f880087842e4
MD5 6f34145a9bc0f2f3fe103020360ade82
BLAKE2b-256 7a22dbc36118528a5b951893a5c63ff7e916f7c138a73f7c7187cc097dd85bf8

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