README.md

---

glaze is a Python library and command line tool for rendering algorithmically-generated fonts and typefaces.

Table of Contents

• Demo
• Installation
• Usage
• Documentation
• Contributing
• License

Demo

>>> import matplotlib.pyplot as plt
>>> from glaze import read_json, render
>>>
>>> font = read_json("data/Georgia.json")
>>> font_name, glyph_name, glyph = font[0]
>>> render(glyph)
>>> plt.show()

Installation

The latest release of glaze can be installed from PyPI:

pip install glaze

Usage

To use glaze as a library:

import matplotlib.pyplot as plt
from glaze import render

fig = render(contours)  # Render one glyph

To run glaze on the command line:

# Recommended usage
glaze --directory PATH/TO/DATA/

# Alternative usage
glaze --files FILES

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

   data
   ├── json
   │   ├── Georgia.json
   │   └── ...
   └── ...

   where the .json files are those produced by knead. Renders will be saved in a directory data/renders-TTTT-DD-MM/, where TTTT is military time.

2. However, should you want to render only a few files, you can use the --files flag, which must be one of:

   • a path to a .json file (again, such as those produced by knead),
   • a comma-separated list of such paths, or
   • a regex matching the path(s) to one or more .json files.

Renders will be saved in the present working directory (unless the --output flag is passed).

Refer to our quickstart for more information on how to use glaze.

Documentation

Please refer to our full documentation.

Contributing

Contributions are always welcome! Please see our issue tracker for outstanding issues, code of conduct for community guidelines, and our contributing guide for details on how to make a contribution.

License

glaze is licensed under the MIT license.