source-foundry / dehinter Goto Github PK

dehinter is a Python command line application that removes TrueType instruction sets, global hinting tables, and other associated OpenType table data in font files. The tool provides cross-platform support on macOS, Windows, and Linux systems with a Python v3.7+ interpreter.

• Removes OpenType glyf table instruction set bytecode data
• Removes OpenType and other TTF hinting related tables - cvt table - fpgm table - hdmx table - LTSH table - prep table - TTFA table (not part of the OpenType specification) - VDMX table
• Removes OpenType cvar table from variable fonts
• Updates gasp table values
• Updates maxp table values
• Updates head table bit flags
• Displays file sizes of the hinted and dehinted versions of the fonts

Options allow you to maintain the original version of any of these tables.

dehinter requires a Python 3.7+ interpreter.

Installation in a Python3 virtual environment is recommended as dependencies are pinned to versions that are confirmed to work with this project.

Use any of the following installation approaches:

$ pip3 install dehinter

$ git clone https://github.com/source-foundry/dehinter.git
$ cd dehinter
$ pip3 install .

The following approach installs the project and associated optional developer dependencies so that source changes are available without the need for re-installation.

$ git clone https://github.com/source-foundry/dehinter.git
$ cd dehinter
$ pip3 install --ignore-installed -r requirements.txt -e ".[dev]"

$ dehinter [OPTIONS] [HINTED FILE PATH]

By default, a new dehinted font build write occurs on the path [ORIGINAL HINTED FONT NAME]-dehinted.ttf in the [HINTED FILE PATH] directory.

Use dehinter -h to view available options.

Please report issues on the project issue tracker.

Contributions are warmly welcomed. A development dependency environment can be installed in editable mode with the developer installation documentation above.

Please use the standard Github pull request approach to propose source changes.

Python source files are linted with flake8. See the Makefile test-lint target for details.

Static type checks are performed on Python source files with mypy and are based on type annotations in the Python source files. See the Makefile test-type-check target for details.

The project runs continuous integration testing on GitHub Actions runners with the pytest testing toolchain. Test modules are located in the tests directory of the repository.

Local testing by Python interpreter version can be performed with the following command executed from the root of the repository:

$ tox -e [PYTHON INTERPRETER VERSION]

Please see the tox documentation for additional details.

Unit test coverage is executed with the coverage tool. See the Makefile test-coverage target for details.

dehinter is built with the fantastic fontTools free software library and is based on the dehinting approach used in the ttfautohint free software project.

Copyright 2019 Source Foundry Authors and Contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.