Metadata-Version: 2.1
Name: emojis
Version: 0.7.0
Summary: Emojis for Python
Home-page: https://github.com/alexandrevicenzi/emojis
Author: Alexandre Vicenzi
Author-email: pypi@alxd.me
Maintainer: Alexandre Vicenzi
Maintainer-email: pypi@alxd.me
License: MIT
Keywords: python,emoji,emojis,unicode
Platform: 
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Topic :: Utilities
License-File: LICENSE

Emojis
======

|Documentation Status| |Build Status| |PyPI| |PyPI - Python Version|

Emojis for Python

About
-----

This library allows you to emojify content such as:
``This is a message with emojis :smile: :snake:``

Emoji database is based on `gemoji <https://github.com/github/gemoji>`__
library.

Example
-------

.. code:: python

   >>> import emojis

   >>> emojis.encode('This is a message with emojis :smile: :snake:')
   'This is a message with emojis 😄 🐍'

   >>> emojis.decode('This is a message with emojis 😄 🐍')
   'This is a message with emojis :smile: :snake:'

   >>> emojis.get('Prefix 😄 🐍 😄 🐍 Sufix')
   {'😄', '🐍'}

   >>> emojis.count('😄 🐍 😄 🐍')
   4

   >>> emojis.count('😄 🐍 😄 🐍', unique=True)
   2

   >>> emojis.db.get_emoji_by_alias('snake')
   Emoji(aliases=['snake'], emoji='🐍', tags=[], category='Animals & Nature', unicode_version='6.0')

   >>> emojis.db.get_categories()
   {'Activities', 'Travel & Places', 'Smileys & Emotion', 'Symbols', 'Food & Drink', 'Animals & Nature', 'People & Body', 'Objects', 'Flags'}

Installation
------------

Install ``emojis`` with ``pip``.

``pip3 install -U emojis``

Documentation
-------------

`https://emojis.readthedocs.io/ <https://emojis.readthedocs.io/en/latest/>`__

Missing or wrong emoji?
-----------------------

This library is based on `gemoji <https://github.com/github/gemoji>`__
database, the official GitHub emoji library for Ruby.

If an emoji is missing or labeled wrongly, report to
`gemoji <https://github.com/github/gemoji>`__ project. If gemoji fix it,
this library will be updated as soon as there’s a new gemoji release.

All issues complaining about missing emojis will be closed.

All PRs to include custom emojis will be closed.

License
-------

MIT

.. |Documentation Status| image:: https://readthedocs.org/projects/emojis/badge/?version=latest
   :target: https://emojis.readthedocs.io/en/latest/?badge=latest
.. |Build Status| image:: https://github.com/alexandrevicenzi/emojis/actions/workflows/test.yml/badge.svg
   :target: https://github.com/alexandrevicenzi/emojis/actions/workflows/test.yml
.. |PyPI| image:: https://img.shields.io/pypi/v/emojis.svg
   :target: https://pypi.org/project/emojis/
.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/emojis.svg
   :target: https://pypi.org/project/emojis/
