knead 0.1.0

A command line tool for preprocessing, manipulating and serializing font files for deep learning applications.

---

knead is a command line tool for preprocessing, manipulating and serializing font files for deep learning applications.

Table of Contents

• Installation
• Usage
• Documentation
• Contributing
• License

Installation

The latest release of knead can be installed from PyPI:

pip install knead

Usage

To run knead on the command line:

knead --input INPUT_FORMAT --output OUTPUT_FORMAT --directory PATH/TO/DATA/

1. The --input and --output flags must be one of:

   • ttf: a .ttf font file.
   • ttx: a .ttx XML format of the font. For more details, refer to the fonttools documentation.
   • json: a .json format of the font.
   • pb: a .pb serialized protobuf format of each glyph in each font.
   • npy: a .npy format of samples from quadratic Bezier curves in each glyph in each font.

2. The --directory must have the following structure:

data
└── ttf
    ├── Georgia.ttf
    └── ...

Documentation

Please refer to our full documentation.

Contributing

Contributions are welcome! Please see our contribution guide for details on how to make a contribution.

License

knead is licensed under the MIT license.