What is this?
User documentation and developer documentation are available at Read the Docs.
FontTools requires Python 3.8 or later. We try to follow the same schedule of minimum Python version support as NumPy (see NEP 29).
The package is listed in the Python Package Index (PyPI), so you can install it with pip:
pip install fonttools
If you would like to contribute to its development, you can clone the repository from GitHub, install the package in 'editable' mode and modify the source code in place. We recommend creating a virtual environment, using virtualenv or Python 3 venv module.
# download the source code to 'fonttools' folder git clone https://github.com/fonttools/fonttools.git cd fonttools # create new virtual environment called e.g. 'fonttools-venv', or anything you like python -m virtualenv fonttools-venv # source the `activate` shell script to enter the environment (Un*x); to exit, just type `deactivate` . fonttools-venv/bin/activate # to activate the virtual environment in Windows `cmd.exe`, do fonttools-venv\Scripts\activate.bat # install in 'editable' mode pip install -e .
fontTools package currently has no (required) external dependencies
besides the modules included in the Python Standard Library.
However, a few extra dependencies are required by some of its modules, which
are needed to unlock optional features.
fonttools PyPI distribution also supports so-called "extras", i.e. a
set of keywords that describe a group of additional dependencies, which can be
used when installing via pip, or when specifying a requirement.
pip install fonttools[ufo,lxml,woff,unicode]
This command will install fonttools, as well as the optional dependencies that are required to unlock the extra features named "ufo", etc.
The module exports a ElementTree-like API for reading/writing XML files, and allows to use as the backend either the built-in
xml.etreemodule or lxml. The latter is preferred whenever present, as it is generally faster and more secure.
Package for reading and writing UFO source files; it requires:
- fs: (aka
pyfilesystem2) filesystem abstraction layer.
- enum34: backport for the built-in
enummodule (only required on Python < 3.4).
- fs: (aka
Module to compress/decompress WOFF 2.0 web fonts; it requires:
- brotli: Python bindings of the Brotli compression library.
To better compress WOFF 1.0 web fonts, the following module can be used instead of the built-in
- zopfli: Python bindings of the Zopfli compression library.
To display the Unicode character names when dumping the
ttxwe use the
unicodedatamodule in the Standard Library. The version included in there varies between different Python versions. To use the latest available data, you can install:
unicodedatabackport for Python 3.x updated to the latest Unicode version 15.0.
Module for finding wrong contour/component order between different masters. It requires one of the following packages in order to solve the so-called "minimum weight perfect matching problem in bipartite graphs", or the Assignment problem:
- scipy: the Scientific Library for Python, which internally uses NumPy arrays and hence is very fast;
- munkres: a pure-Python module that implements the Hungarian or Kuhn-Munkres algorithm.
Module for visualizing DesignSpaceDocument and resulting VariationModel.
- matplotlib: 2D plotting library.
Advanced module for symbolic font statistics analysis; it requires:
- sympy: the Python library for symbolic mathematics.
To get the file creator and type of Macintosh PostScript Type 1 fonts on Python 3 you need to install the following module, as the old
MacOSmodule is no longer included in Mac Python:
- xattr: Python wrapper for extended filesystem attributes (macOS platform only).
Simplify TrueType glyphs by merging overlapping contours and components.
- skia-pathops: Python bindings for the Skia library's PathOps module, performing boolean operations on paths (union, intersection, etc.).
Pens for drawing glyphs with Cocoa
- PyObjC: the bridge between Python and the Objective-C runtime (macOS platform only).
Pen for drawing glyphs with Qt's
- PyQt5: Python bindings for the Qt cross platform UI and application toolkit.
Pen to drawing glyphs as PNG images, requires:
- reportlab: Python toolkit for generating PDFs and graphics.
Pen to drawing glyphs with FreeType as raster images, requires:
- freetype-py: Python binding for the FreeType library.
Use the Harfbuzz library to serialize GPOS/GSUB using
- uharfbuzz: Streamlined Cython bindings for the harfbuzz shaping engine
How to make a new release
NEWS.rstwith all the changes since the last release. Write a changelog entry for each PR, with one or two short sentences summarizing it, as well as links to the PR and relevant issues addressed by the PR. Do not put a new title, the next command will do it for you.
- Use semantic versioning to decide whether the new release will be a 'major', 'minor' or 'patch' release. It's usually one of the latter two, depending on whether new backward compatible APIs were added, or simply some bugs were fixed.
python setup.py releasecommand from the tip of the
mainbranch. By default this bumps the third or 'patch' digit only, unless you pass
--minorto bump respectively the first or second digit. This bumps the package version string, extracts the changes since the latest version from
NEWS.rst, and uses that text to create an annotated git tag (or a signed git tag if you pass the
--signoption and your git and Github account are configured for signing commits using a GPG key). It also commits an additional version bump which opens the main branch for the subsequent developmental cycle
- Push both the tag and commit to the upstream repository, by running the command
git push --follow-tags. Note: it may push other local tags as well, be careful.
- Let the CI build the wheel and source distribution packages and verify both get uploaded to the Python Package Index (PyPI).
- [Optional] Go to fonttools Github Releases page and create a new release, copy-pasting the content of the git tag message. This way, the release notes are nicely formatted as markdown, and users watching the repo will get an email notification. One day we shall automate that too.
In alphabetical order:
aschmitz, Olivier Berten, Samyak Bhuta, Erik van Blokland, Petr van Blokland, Jelle Bosma, Sascha Brawer, Tom Byrer, Antonio Cavedoni, Frédéric Coiffier, Vincent Connare, David Corbett, Simon Cozens, Dave Crossland, Simon Daniels, Peter Dekkers, Behdad Esfahbod, Behnam Esfahbod, Hannes Famira, Sam Fishman, Matt Fontaine, Takaaki Fuji, Yannis Haralambous, Greg Hitchcock, Jeremie Hornus, Khaled Hosny, John Hudson, Denis Moyogo Jacquerye, Jack Jansen, Tom Kacvinsky, Jens Kutilek, Antoine Leca, Werner Lemberg, Tal Leming, Peter Lofting, Cosimo Lupo, Olli Meier, Masaya Nakamura, Dave Opstad, Laurence Penney, Roozbeh Pournader, Garret Rieger, Read Roberts, Colin Rofls, Guido van Rossum, Just van Rossum, Andreas Seidel, Georg Seifert, Chris Simpkins, Miguel Sousa, Adam Twardoch, Adrien Tétar, Vitaly Volkov, Paul Wise.
Copyright (c) 2000 BeOpen.com. All Rights Reserved.
Copyright (c) 1995-2001 Corporation for National Research Initiatives. All Rights Reserved.
Copyright (c) 1991-1995 Stichting Mathematisch Centrum, Amsterdam. All Rights Reserved.