https://github.com/carpedm20/emoji

emoji terminal output for Python
https://github.com/carpedm20/emoji

emoji python

Last synced: 5 days ago
JSON representation

emoji terminal output for Python

• Host: GitHub
• URL: https://github.com/carpedm20/emoji
• Owner: carpedm20
• License: other
• Created: 2014-08-18T02:55:59.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-10-04T08:09:22.000Z (3 months ago)
• Last Synced: 2024-12-30T19:05:57.304Z (12 days ago)
• Topics: emoji, python
• Language: Python
• Size: 16.2 MB
• Stars: 1,914
• Watchers: 25
• Forks: 278
• Open Issues: 19
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.md
  • License: LICENSE.txt

Awesome Lists containing this project

• best-of-python - GitHub - 8% open · ⏱️ 20.05.2024): (Text Data)
• awesome - carpedm20/emoji - emoji terminal output for Python (Python)
• awesome-list - Emoji - emoji terminal output for Python. (Desktop App Development / Python Toolkit)

README

        
Emoji

=====

Emoji for Python.  This project was inspired by `kyokomi `__.

Example

-------

The entire set of Emoji codes as defined by the `Unicode consortium `__

is supported in addition to a bunch of `aliases `__.  By

default, only the official list is enabled but doing ``emoji.emojize(language='alias')`` enables

both the full list and aliases.

.. code-block:: python

    >>> import emoji

    >>> print(emoji.emojize('Python is :thumbs_up:'))

    Python is 👍

    >>> print(emoji.emojize('Python is :thumbsup:', language='alias'))

    Python is 👍

    >>> print(emoji.demojize('Python is 👍'))

    Python is :thumbs_up:

    >>> print(emoji.emojize("Python is fun :red_heart:"))

    Python is fun ❤

    >>> print(emoji.emojize("Python is fun :red_heart:", variant="emoji_type"))

    Python is fun ❤️ #red heart, not black heart

    >>> print(emoji.is_emoji("👍"))

    True

..

By default, the language is English (``language='en'``) but also supported languages are:

* Spanish (``'es'``)

* Portuguese (``'pt'``)

* Italian (``'it'``)

* French (``'fr'``)

* German (``'de'``)

* Farsi/Persian (``'fa'``)

* Indonesian (``'id'``)

* Simplified Chinese (``'zh'``)

* Japanese (``'ja'``)

* Korean (``'ko'``)

* Russian (``'ru'``)

* Arabic (``'ar'``)

* Turkish (``'tr'``)

.. code-block:: python

    >>> print(emoji.emojize('Python es :pulgar_hacia_arriba:', language='es'))

    Python es 👍

    >>> print(emoji.demojize('Python es 👍', language='es'))

    Python es :pulgar_hacia_arriba:

    >>> print(emoji.emojize("Python é :polegar_para_cima:", language='pt'))

    Python é 👍

    >>> print(emoji.demojize("Python é 👍", language='pt'))

    Python é :polegar_para_cima:️

..

Installation

------------

Via pip:

.. code-block:: console

    $ python -m pip install emoji --upgrade

From master branch:

.. code-block:: console

    $ git clone https://github.com/carpedm20/emoji.git

    $ cd emoji

    $ python -m pip install .

Developing

----------

.. code-block:: console

    $ git clone https://github.com/carpedm20/emoji.git

    $ cd emoji

    $ python -m pip install -e .\[dev\]

    $ pytest

    $ coverage run -m pytest

    $ coverage report

The ``utils/generate_emoji.py`` script is used to generate

``unicode_codes/emoji.json``. Generally speaking it scrapes a table on the

`Unicode Consortium's website `__

with `BeautifulSoup `__

For more information take a look in the `utils/README.md `__ file.

Check the code style with:

.. code-block:: console

    $ python -m pip install ruff

    $ ruff check emoji

Test the type checks with:

.. code-block:: console

    $ python -m pip install pyright mypy typeguard

    $ pyright emoji

    $ pyright tests

    $ mypy emoji

    $ pytest --typeguard-packages=emoji

Links

-----

**Documentation**

`https://carpedm20.github.io/emoji/docs/ `__

**Overview of all emoji:**

`https://carpedm20.github.io/emoji/ `__

(auto-generated list of the emoji that are supported by the current version of this package)

**For English:**

`Emoji Cheat Sheet `__

`Official Unicode list `__

**For Spanish:**

`Unicode list `__

**For Portuguese:**

`Unicode list `__

**For Italian:**

`Unicode list `__

**For French:**

`Unicode list `__

**For German:**

`Unicode list `__

Authors

-------

Taehoon Kim / `@carpedm20 `__

Kevin Wurster / `@geowurster `__

Maintainer

----------

Tahir Jalilov / `@TahirJalilov `__