Metadata-Version: 2.1
Name: gftools
Version: 0.9.62
Summary: Google Fonts Tools is a set of command-line tools for testing font projects
Author: Felipe Sanches, Lasse Fister, Eli Heuer, Roderick Sheeter
Author-email: Marc Foley <m.foley.88@gmail.com>, Dave Crossland <dave@lab6.com>, Simon Cozens <simon@simon-cozens.org>
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Topic :: Text Processing :: Fonts
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: setuptools
Requires-Dist: FontTools[ufo]
Requires-Dist: axisregistry>=0.4.9
Requires-Dist: absl-py
Requires-Dist: glyphsLib
Requires-Dist: gflanguages>=0.6.0
Requires-Dist: gfsubsets>=2024.02.05
Requires-Dist: glyphsets>=0.6.13
Requires-Dist: PyGithub
Requires-Dist: pillow
Requires-Dist: protobuf<4,>=3.7.0
Requires-Dist: requests
Requires-Dist: tabulate
Requires-Dist: unidecode
Requires-Dist: opentype-sanitizer
Requires-Dist: vttlib
Requires-Dist: pygit2<1.15.0
Requires-Dist: strictyaml
Requires-Dist: fontmake[json]>=3.3.0
Requires-Dist: skia-pathops
Requires-Dist: statmake
Requires-Dist: PyYAML
Requires-Dist: babelfont
Requires-Dist: ttfautohint-py
Requires-Dist: brotli
Requires-Dist: jinja2
Requires-Dist: fontFeatures
Requires-Dist: vharfbuzz
Requires-Dist: bumpfontversion
Requires-Dist: nanoemoji>=0.15.0
Requires-Dist: font-v
Requires-Dist: afdko
Requires-Dist: beautifulsoup4
Requires-Dist: rich
Requires-Dist: packaging
Requires-Dist: ninja
Requires-Dist: networkx
Requires-Dist: ruamel.yaml
Provides-Extra: qa
Requires-Dist: fontbakery[googlefonts]; extra == "qa"
Requires-Dist: diffenator2>=0.2.0; extra == "qa"
Requires-Dist: pycairo; extra == "qa"
Provides-Extra: test
Requires-Dist: black==24.4.2; extra == "test"
Requires-Dist: pytest; extra == "test"

[![CI Build Status](https://github.com/googlefonts/gftools/workflows/Test/badge.svg?branch=main)](https://github.com/googlefonts/gftools/actions/workflows/ci.yml?query=workflow%3ATest+branch%3Amain)
[![PyPI](https://img.shields.io/pypi/v/gftools.svg)](https://pypi.org/project/gftools/)

# Google Fonts Tools

This project contains tools used for working with the Google Fonts collection, plus **Google Fonts Glyph Set Documentation** in the [/encodings](https://github.com/googlefonts/gftools/tree/main/Lib/gftools/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](LICENSE)

## Google Fonts Official Glyph Sets

The glyph sets useful for type designers that were previously hosted in this repository have been moved to:

<https://github.com/googlefonts/glyphsets/tree/main/GF_glyphsets>

## Tool 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

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](./docs/gftools-packager).

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

## Tool Installation


**Please note that gftools requires [Python 3.7](http://www.python.org/download/) or later.**

Please install these tools using pip:

    pip install gftools

If you would like to use `gftools qa`:

    pip install 'gftools[qa]'


### Tool Requirements and Dependencies

`gftools 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.

`gftools manage-traffic-jam` requires two private files which contain sensitive data. Ask m4rc1e for them.

### 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**

* https://github.com/google/protobuf
* https://github.com/behdad/fonttools
