Description

|CI Build Status| |Coverage Status| |PyPI| |Gitter Chat| What is this? ~~~~~~~~~~~~~ | fontTools is a library for manipulating fonts, written in Python. The project includes the TTX tool, that can convert TrueType and OpenType fonts to and from an XML text format, which is also called TTX. It supports TrueType, OpenType, AFM and to an extent Type 1 and some Mac-specific formats. The project has an `MIT open-source license <LICENSE>`__. | Among other things this means you can use it free of charge. `User documentation <https://fonttools.readthedocs.io/en/latest/>`_ and `developer documentation <https://fonttools.readthedocs.io/en/latest/developer.html>`_ are available at `Read the Docs <https://fonttools.readthedocs.io/>`_. Installation ~~~~~~~~~~~~ FontTools requires `Python <http://www.python.org/download/>`__ 3.10 or later. We try to follow the same schedule of minimum Python version support as NumPy (see `NEP 29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`__). The package is listed in the Python Package Index (PyPI), so you can install it with `pip <https://pip.pypa.io>`__: .. code:: sh 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 <https://virtualenv.pypa.io>`__ or Python 3 `venv <https://docs.python.org/3/library/venv.html>`__ module. .. code:: sh # 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 (Unix-like); 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 . Optional Requirements --------------------- The ``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. The ``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. For example: .. code:: sh 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. - ``Lib/fontTools/misc/etree.py`` The module exports a ElementTree-like API for reading/writing XML files, and allows to use as the backend either the built-in ``xml.etree`` module or `lxml <https://lxml.de>`__. The latter is preferred whenever present, as it is generally faster and more secure. *Extra:* ``lxml`` - ``Lib/fontTools/ttLib/woff2.py`` Module to compress/decompress WOFF 2.0 web fonts; it requires: * `brotli <https://pypi.python.org/pypi/Brotli>`__: Python bindings of the Brotli compression library. *Extra:* ``woff`` - ``Lib/fontTools/ttLib/sfnt.py`` To better compress WOFF 1.0 web fonts, the following module can be used instead of the built-in ``zlib`` library: * `zopfli <https://pypi.python.org/pypi/zopfli>`__: Python bindings of the Zopfli compression library. *Extra:* ``woff`` - ``Lib/fontTools/unicode.py`` To display the Unicode character names when dumping the ``cmap`` table with ``ttx`` we use the ``unicodedata`` module in the Standard Library. The version included in there varies between different Python versions. To use the latest available data, you can install: * `unicodedata2 <https://pypi.python.org/pypi/unicodedata2>`__: ``unicodedata`` backport for Python 3.x updated to the latest Unicode version 17.0. *Extra:* ``unicode`` - ``Lib/fontTools/varLib/interpolatable.py`` 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 <https://pypi.python.org/pypi/scipy>`__: the Scientific Library for Python, which internally uses `NumPy <https://pypi.python.org/pypi/numpy>`__ arrays and hence is very fast; * `munkres <https://pypi.python.org/pypi/munkres>`__: a pure-Python module that implements the Hungarian or Kuhn-Munkres algorithm. Slower than SciPy, but useful for minimalistic systems where adding SciPy is undesirable. This ensures both performance (via SciPy) and minimal footprint (via Munkres) are possible. To plot the result