Skip to main content

Google Fonts Tools is a set of command-line tools for testing font projects

Project description

Google Fonts Tools

This project contains tools used for working with the Google Fonts collection, plus Google Fonts Glyph Set Documentation in the /encodings subdirectory. While these tools are primarily intended for contributors to the Google Fonts project, anyone who works with fonts could find them useful.

The tools and files under this directory are available under the Apache License v2.0, for details see LICENSE

Google Fonts Official Glyph Sets (Encodings)

https://github.com/googlefonts/gftools/tree/master/Lib/gftools/encodings

Usage Examples

Compare fonts:

gftools compare-font font1.ttf font2.ttf

Add a METADATA.pb to a family directory

gftools add-font ../ofl/newfamily

Sanity check a family directory:

gftools sanity-check --repair_script=/tmp/fix.py ../ofl/josefinsans
gftools sanity-check --repair_script=/tmp/fix.py --fix_type=fsSelection ../ufl

Check a font family against the same family hosted on Google Fonts:

gftools qa [fonts.ttf] -gfb -a -o qa

Check a variable font family against the same family as static fonts:

gftools qa -f [vf_fonts] -fb [static_fonts] --diffenator --diffbrowsers -o ~/path/out

Add a DSIG table to a font

gftools fix-dsig font1.ttf

Fix a non hinted font

gftools fix-nonhinting font_in.ttf font_out.ttf

Package and PR a family update to google/fonts. Much more detailed documentation.

gftools packager "Family Sans" path/to/local/google/fonts -py

Installation

Please install these tools using pip:

pip install gftools

If you need to use gftools qa, you will need to install Harfbuzz, Cairo, FreeType and pkg-config. These can be installed on OS X using homebrew:

brew install cairo freetype harfbuzz pkg-config

Once You have installed these system packages, install gftools using the following command:

pip install 'gftools[qa]'

Requirements and Dependencies

These tools depend on the submodule GlyphsInfo. Make sure the submodule is up to date by running:

git submodule update --init --recursive

gftool packager needs the command line git program in a version >= Git 2.5 (Q2 2015) in order to perform a shallow clone (--depth 1) of the font upstream repository and branch. This is not supported by pygit2/libgit2 yet.

Google Fonts API Key

In order to use the scripts gftools qa and gftools family-html-snippet, you will need to generate a Google Fonts api key, https://developers.google.com/fonts/. You will then need to create a new text file located on your system at ~/.gf-api-key (where ~ is your home directory), which contains the following:

[Credentials]
key = your-newly-generated-googlefonts-api-key

Upstream project repos

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

gftools-0.6.0.tar.gz (5.4 MB view details)

Uploaded Source

Built Distribution

gftools-0.6.0-py3-none-any.whl (2.8 MB view details)

Uploaded Python 3

File details

Details for the file gftools-0.6.0.tar.gz.

File metadata

  • Download URL: gftools-0.6.0.tar.gz
  • Upload date:
  • Size: 5.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

File hashes

Hashes for gftools-0.6.0.tar.gz
Algorithm Hash digest
SHA256 58ee47de4b6d914c5611873789d11340b0ce97094cc76eef5044eeb963d0f3d9
MD5 bed289e081abd36105fa2176c938e78a
BLAKE2b-256 6bd05a197e75b394ced50893a4a5251d634f09fdad4fe6555338a947feeb6b8f

See more details on using hashes here.

File details

Details for the file gftools-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: gftools-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 2.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

File hashes

Hashes for gftools-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 688e229117980691932e561a37fc37bae53ac4eda1fcc1bc4419297f5cba66c2
MD5 ba14a394ffa1a5cbd5022a2836c22f71
BLAKE2b-256 7300bdb69d47174c2c9fba3b7f9f31b0c01b8e30dbd5eb79979eeaa3c1919bd0

See more details on using hashes here.

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