README.md

emojicompat

Utility to help create and verify fonts for https://developer.android.com/guide/topics/ui/look-and-feel/emoji-compat.

Requires Python 3.7 or greater.

Usage

# Assumes current directory is the root of a clone of the repo

# Make a venv your favorite way. Mine is:
python3 -m venv venv
source venv/bin/activate

# Install emojicompat
pip install -e .

# You should now have emojicompat on path
which emojicompat
# should return path/to/current/venv/bin/emojicompat

# Add metadata to a font
emojicompat --op setup --font /tmp/Noto-COLRv1.ttf

# Validate the metadata in a font
emojicompat --op check --font /tmp/Noto-COLRv1.ttf

# Dump the metadata in a font
emojicompat --op dump --font /tmp/Noto-COLRv1.ttf

Developer instructions

Support new unicode sequences

Examples are shown based on upgrade from Unicode 14 to 15.

1. Update the minimum https://github.com/googlefonts/nototools version in setup.py to one that supports the latest unicode "notofonttools>=0.2.17", # unicode 15

2. Generate an update to https://github.com/googlefonts/emojicompat/blob/main/src/emojicompat/emoji_metadata.txt.

   • Set sdkAdded per #10

   # in a venv
   pip install -e .[dev]
   python update_emoji_metadata.py --sdk_added 1500
   

Test

Install the dev dependencies specified in extras_require.

pip install -e .[dev]
pytest

If you use zsh, it will prompt an error(zsh: no matches found: .[dev]). Please use the following command:

pip install -e '.[dev]'

You can also use pytest to test the specified files individually.

pytest tests/svg_test.py

Releasing

See https://googlefonts.github.io/python#make-a-release.