Installation

May 6, 2018 ยท View on GitHub

PyPI version PyPI pyversions PyPI license

๐Ÿ”Ž the most similar ๐Ÿ˜€s in ๐Ÿ3๏ธโƒฃ.

  • This is an application of TopSim, which searches the most similar strings against the query in Python 3.

The list of emojis are obtained from the official source Full Emoji List.

Installation

This package is available on PyPI. Just use pip3 install -U TopEmoji to install it.

CLI Usage

You can simply use the algorithm on terminal.

Usage:
    topemoji-cli <query> [-k <k>]
  • Each emoji and its description and similarity, are printed to terminal and separated by tab character \t.
topemoji-cli "baby" -k 5
๐Ÿ‘ถ	baby	1.0
๐Ÿ‘ผ	baby angel	0.666
๐Ÿค	baby chick	0.666
๐Ÿผ	baby bottle	0.6659
๐Ÿšผ	baby symbol	0.6659
  • You can also use emoji as query.
topemoji-cli "๐Ÿ˜€" -k 5
๐Ÿ˜€	grinning face	1.0
๐Ÿ˜†	grinning squinting face	0.9993
๐Ÿ˜บ	grinning cat face	0.9331
๐Ÿ˜…	grinning face with sweat	0.866
๐Ÿ˜ƒ	grinning face with big eyes	0.8659

API Usage

Alternatively, you can use the algorithm via API.

from topemoji import search

print(search("baby", k=5)) # Return each similarity and the respective emojis.
# [(1.0, [('๐Ÿ‘ถ', 'baby')]),
#  (0.6660006660006661, [('๐Ÿ‘ผ', 'baby angel'), ('๐Ÿค', 'baby chick')]),
#  (0.665889795238888, [('๐Ÿผ', 'baby bottle'), ('๐Ÿšผ', 'baby symbol')])]