Skip to main content

A bridge from Glyphs source files (.glyphs) to UFOs

Project description

Travis Build Status PyPI Version Codecov

glyphsLib

This library provides a bridge from Glyphs source files (.glyphs) to UFOs via defcon.

The main methods for conversion are found in __init__.py. Intermediate data can be accessed without actually writing UFOs, if needed.

Write and return UFOs

Masters:

master_dir = 'master_ufos'
ufos = glyphsLib.build_masters('MyFont.glyphs', master_dir)

Interpolated instances (depends on MutatorMath):

master_dir = 'master_ufos'
instance_dir = 'instance_ufos'
ufos = glyphsLib.build_instances('MyFont.glyphs', master_dir, instance_dir)

Load UFO objects without writing

ufos = glyphsLib.load_to_ufos('MyFont.glyphs')

Read and write Glyphs data as Python objects

from glyphsLib import GSFont

font = GSFont(glyphs_file)

font.save(glyphs_file)

The glyphsLib.classes module aims to provide an interface similar to Glyphs.app’s Python Scripting API.

Note that currently not all the classes and methods may be fully implemented. We try to keep up to date, but if you find something that is missing or does not work as expected, please open a issue.

Go back and forth between UFOs and Glyphs

  1. Without a designspace file, using for example the Inria fonts by Black[Foundry]:

import glob
from defcon import Font
from glyphsLib import to_glyphs
ufos = [Font(path) for path in glob.glob('*Italic.ufo')]
# Sort the UFOs because glyphsLib will create masters in the same order
ufos = sorted(ufos, key=lambda ufo: ufo.info.openTypeOS2WeightClass)
font = to_glyphs(ufos)
font.save('InriaSansItalic.glyphs')

Here is the resulting glyphs file

  1. With a designspace, using Spectral from Production Type:

import glob
from fontTools.designspaceLib import DesignSpaceDocument
from glyphsLib import to_glyphs
doc = DesignSpaceDocument()
doc.read('spectral-build-roman.designspace')
font = to_glyphs(doc)
font.save('SpectralRoman.glyphs')

Here is the resulting glyphs file

3. In both cases, if you intend to go back to UFOs after modifying the file with Glyphs, you should use the minimize_ufo_diffs parameter to minimize the amount of diffs that will show up in git after the back and forth. To do so, the glyphsLib will add some bookkeeping values in various userData fields. For example, it will try to remember which GSClass came from groups.plist or from the feature file.

The same option exists for people who want to do Glyphs->UFOs->Glyphs: minimize_glyphs_diffs, which will add some bookkeeping data in UFO lib. For example, it will keep the same UUIDs for Glyphs layers, and so will need to store those layer UUIDs in the UFOs.

import glob
import os
from fontTools.designspaceLib import DesignSpaceDocument
from glyphsLib import to_glyphs, to_designspace, GSFont
doc = DesignSpaceDocument()
doc.read('spectral-build-roman.designspace')
font = to_glyphs(doc, minimize_ufo_diffs=True)
doc2 = to_designspace(font, propagate_anchors=False)
# UFOs are in memory only, attached to the doc via `sources`
# Writing doc2 over the original doc should generate very few git diffs (ideally none)
doc2.write(doc.path)
for source in doc2.sources:
    path = os.path.join(os.path.dirname(doc.path), source.filename)
    # You will want to use ufoNormalizer after
    source.font.save(path)

font = GSFont('SpectralRoman.glyphs')
doc = to_designspace(font, minimize_glyphs_diffs=True, propagate_anchors=False)
font2 = to_glyphs(doc)
# Writing font2 over font should generate very few git diffs (ideally none):
font2.save(font.filepath)

In practice there are always a few diffs on things that don’t really make a difference, like optional things being added/removed or whitespace changes or things getting reordered…

Project details


Release history Release notifications | RSS feed

This version

2.3.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

glyphsLib-2.3.0.zip (393.3 kB view details)

Uploaded Source

Built Distribution

glyphsLib-2.3.0-py2.py3-none-any.whl (308.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file glyphsLib-2.3.0.zip.

File metadata

  • Download URL: glyphsLib-2.3.0.zip
  • Upload date:
  • Size: 393.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for glyphsLib-2.3.0.zip
Algorithm Hash digest
SHA256 605a53ad0d5052c6aeaa7a021ccc70f5f0fbaaed87333ca6b12997cb2af255d2
MD5 09ad1cbbc61fd0721955a6a2fac9702c
BLAKE2b-256 309d5a36a0d877d7dd7d8d59941e69e40a0b8763ad0e0590a91deacf253fc30c

See more details on using hashes here.

Provenance

File details

Details for the file glyphsLib-2.3.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for glyphsLib-2.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 062506cb854a431794c12f03ba2e6faad247b51feab3d59bebca8bdd10a11217
MD5 f5637e6387adb88d9d465478954cbd0d
BLAKE2b-256 16bb2f275ab87b2fd3ab5c83019544b35211f3df09f0fe0309f7872139d659b5

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page