| single |
![Test and Build]
[Codecov]
[PyPI]
[![Language grade:
C/C++]](https://lgtm.com/projects/g/adobe-type-tools/psautohint/context:cpp)
[![Language grade:
Python]](https://lgtm.com/projects/g/adobe-type-tools/psautohint/context:python)
[Total alerts]
PSAutoHint
==========
A standalone version of [AFDKO]’s
autohinter.
Building and running
--------------------
This repository currently consists of a core autohinter written in C, a
Python C extension providing an interface to it, and helper Python code.
To build the C extension:
python setup.py build
To install the C extension and the helper scripts globally:
pip install -r requirements.txt .
Alternatively to install them for the current user:
pip install -r requirements.txt --user .
The autohinter can be used by running:
psautohint
To build just the `autohintexe` binary:
python setup.py build_exe
Testing
-------
We have a test suite that can be run with:
pytest
Debugging
---------
For standard debugging, build with:
python setup.py build --debug
It is also possible to build a debug version with [AddressSanitizer]
("ASan") support (currently _for Mac OS X only_) with:
python setup.py build --asan
pip install .
Once it is installed, you can use the `util/launch-asan.sh` shell script to
launch a Python process that invokes the ASan libraries needed for
debugging. Attach Xcode the launched process, then execute code in the
process that triggers memory usage problems and wait for ASan to do its
magic.
NOTE: be sure to build and install `psautohint` as described above; using
other techniques such as `python setup.py install` will cause a re-build
_without_ ASan and debug support, which won't work.
|