/emojitations

Use Unicode emoji annotations from Python!

Primary LanguagePythonMIT LicenseMIT

Emojitations

A library for using Unicode emoji annotations. Emoji annotations can provide your scripts with a simple way to interpret emoji, or select a random one satisfying certain criteria. Annotations can be seen listed here on the Unicode website: http://unicode.org/emoji/charts/full-emoji-list.html

Requirements

  1. Python 3.+

This library is pure python 3 and has no other requirements.

Installation

python3 setup.py install

Usage

Emoji are available under their names at emoji.whatever. These objects include an annotations set and you can use the emoji attribute or str() to get their emoji strings. To get all emoji in an annotation, use emoji.annotation.whatever. This returns frozen sets which then can be combined using set operations.

To get info on a particular emoji, you can request emoji['πŸ”β€™] or emoji.get(β€™πŸ”β€™) and look at its name and annotations.

(Should Python ever support emoji identifiers, emoji.😜 would also work. Unfortunately we do not yet live in that beautiful world.)

The library also provides (preliminary) support for foreign languages, available as emoji.de.kreditkarte for example. Names & annotations are drawn from the Unicode LDML, and differ for different languages, so emoji.en[β€˜πŸŽ²β€™] != emoji.de[β€˜πŸŽ²β€™].

See the examples below for details.

>>> from emojitations import emoji
>>> emoji.grinning_face.annotations
frozenset({'grin', 'face'})
>>> print(''.join(str(grin) for grin in emoji.annotation.grin))
πŸ˜ΈπŸ˜πŸ˜€
>>> print(''.join(str(grin) for grin in emoji.annotation.grin & emoji.annotation.cat))
😸
>>> print(str(emoji.de.kreditkarte))
πŸ’³