emoji


Nameemoji JSON
Version 2.14.0 PyPI version JSON
download
home_pageNone
SummaryEmoji for Python
upload_time2024-10-04 08:04:51
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseNone
keywords emoji
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Emoji
=====

Emoji for Python.  This project was inspired by `kyokomi <https://github.com/kyokomi/emoji>`__.


Example
-------

The entire set of Emoji codes as defined by the `Unicode consortium <https://unicode.org/emoji/charts/full-emoji-list.html>`__
is supported in addition to a bunch of `aliases <https://www.webfx.com/tools/emoji-cheat-sheet/>`__.  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 <https://www.unicode.org/reports/tr51/#emoji_data>`__
with `BeautifulSoup <http://www.crummy.com/software/BeautifulSoup/>`__
For more information take a look in the `utils/README.md <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/ <https://carpedm20.github.io/emoji/docs/>`__

**Overview of all emoji:**

`https://carpedm20.github.io/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 <https://www.webfx.com/tools/emoji-cheat-sheet/>`__

`Official Unicode list <http://www.unicode.org/emoji/charts/full-emoji-list.html>`__

**For Spanish:**

`Unicode list <https://emojiterra.com/es/lista-es/>`__

**For Portuguese:**

`Unicode list <https://emojiterra.com/pt/lista/>`__

**For Italian:**

`Unicode list <https://emojiterra.com/it/lista-it/>`__

**For French:**

`Unicode list <https://emojiterra.com/fr/liste-fr/>`__

**For German:**

`Unicode list <https://emojiterra.com/de/liste/>`__


Authors
-------

Taehoon Kim / `@carpedm20 <http://carpedm20.github.io/about/>`__

Kevin Wurster / `@geowurster <http://twitter.com/geowurster/>`__

Maintainer
----------
Tahir Jalilov / `@TahirJalilov <https://github.com/TahirJalilov>`__

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "emoji",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "emoji",
    "author": null,
    "author_email": "Taehoon Kim <carpedm20@gmail.com>, Kevin Wurster <wursterk@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/13/64/812d7e2ae0ac2ade0d6583f911f99240c80f700afbe8391df10e547f564d/emoji-2.14.0.tar.gz",
    "platform": null,
    "description": "Emoji\n=====\n\nEmoji for Python.  This project was inspired by `kyokomi <https://github.com/kyokomi/emoji>`__.\n\n\nExample\n-------\n\nThe entire set of Emoji codes as defined by the `Unicode consortium <https://unicode.org/emoji/charts/full-emoji-list.html>`__\nis supported in addition to a bunch of `aliases <https://www.webfx.com/tools/emoji-cheat-sheet/>`__.  By\ndefault, only the official list is enabled but doing ``emoji.emojize(language='alias')`` enables\nboth the full list and aliases.\n\n.. code-block:: python\n\n    >>> import emoji\n    >>> print(emoji.emojize('Python is :thumbs_up:'))\n    Python is \ud83d\udc4d\n    >>> print(emoji.emojize('Python is :thumbsup:', language='alias'))\n    Python is \ud83d\udc4d\n    >>> print(emoji.demojize('Python is \ud83d\udc4d'))\n    Python is :thumbs_up:\n    >>> print(emoji.emojize(\"Python is fun :red_heart:\"))\n    Python is fun \u2764\n    >>> print(emoji.emojize(\"Python is fun :red_heart:\", variant=\"emoji_type\"))\n    Python is fun \u2764\ufe0f #red heart, not black heart\n    >>> print(emoji.is_emoji(\"\ud83d\udc4d\"))\n    True\n\n..\n\nBy default, the language is English (``language='en'``) but also supported languages are:\n\n* Spanish (``'es'``)\n* Portuguese (``'pt'``)\n* Italian (``'it'``)\n* French (``'fr'``)\n* German (``'de'``)\n* Farsi/Persian (``'fa'``)\n* Indonesian (``'id'``)\n* Simplified Chinese (``'zh'``)\n* Japanese (``'ja'``)\n* Korean (``'ko'``)\n* Russian (``'ru'``)\n* Arabic (``'ar'``)\n* Turkish (``'tr'``)\n\n\n.. code-block:: python\n\n    >>> print(emoji.emojize('Python es :pulgar_hacia_arriba:', language='es'))\n    Python es \ud83d\udc4d\n    >>> print(emoji.demojize('Python es \ud83d\udc4d', language='es'))\n    Python es :pulgar_hacia_arriba:\n    >>> print(emoji.emojize(\"Python \u00e9 :polegar_para_cima:\", language='pt'))\n    Python \u00e9 \ud83d\udc4d\n    >>> print(emoji.demojize(\"Python \u00e9 \ud83d\udc4d\", language='pt'))\n    Python \u00e9 :polegar_para_cima:\ufe0f\n\n..\n\nInstallation\n------------\n\nVia pip:\n\n.. code-block:: console\n\n    $ python -m pip install emoji --upgrade\n\nFrom master branch:\n\n.. code-block:: console\n\n    $ git clone https://github.com/carpedm20/emoji.git\n    $ cd emoji\n    $ python -m pip install .\n\n\nDeveloping\n----------\n\n.. code-block:: console\n\n    $ git clone https://github.com/carpedm20/emoji.git\n    $ cd emoji\n    $ python -m pip install -e .\\[dev\\]\n    $ pytest\n    $ coverage run -m pytest\n    $ coverage report\n\nThe ``utils/generate_emoji.py`` script is used to generate\n``unicode_codes/emoji.json``. Generally speaking it scrapes a table on the\n`Unicode Consortium's website <https://www.unicode.org/reports/tr51/#emoji_data>`__\nwith `BeautifulSoup <http://www.crummy.com/software/BeautifulSoup/>`__\nFor more information take a look in the `utils/README.md <utils/README.md>`__ file.\n\nCheck the code style with:\n\n.. code-block:: console\n\n    $ python -m pip install ruff\n    $ ruff check emoji\n\nTest the type checks with:\n\n.. code-block:: console\n\n    $ python -m pip install pyright mypy typeguard\n    $ pyright emoji\n    $ pyright tests\n    $ mypy emoji\n    $ pytest --typeguard-packages=emoji\n\n\nLinks\n-----\n\n**Documentation**\n\n`https://carpedm20.github.io/emoji/docs/ <https://carpedm20.github.io/emoji/docs/>`__\n\n**Overview of all emoji:**\n\n`https://carpedm20.github.io/emoji/ <https://carpedm20.github.io/emoji/>`__\n\n(auto-generated list of the emoji that are supported by the current version of this package)\n\n**For English:**\n\n`Emoji Cheat Sheet <https://www.webfx.com/tools/emoji-cheat-sheet/>`__\n\n`Official Unicode list <http://www.unicode.org/emoji/charts/full-emoji-list.html>`__\n\n**For Spanish:**\n\n`Unicode list <https://emojiterra.com/es/lista-es/>`__\n\n**For Portuguese:**\n\n`Unicode list <https://emojiterra.com/pt/lista/>`__\n\n**For Italian:**\n\n`Unicode list <https://emojiterra.com/it/lista-it/>`__\n\n**For French:**\n\n`Unicode list <https://emojiterra.com/fr/liste-fr/>`__\n\n**For German:**\n\n`Unicode list <https://emojiterra.com/de/liste/>`__\n\n\nAuthors\n-------\n\nTaehoon Kim / `@carpedm20 <http://carpedm20.github.io/about/>`__\n\nKevin Wurster / `@geowurster <http://twitter.com/geowurster/>`__\n\nMaintainer\n----------\nTahir Jalilov / `@TahirJalilov <https://github.com/TahirJalilov>`__\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Emoji for Python",
    "version": "2.14.0",
    "project_urls": {
        "homepage": "https://github.com/carpedm20/emoji/",
        "repository": "https://github.com/carpedm20/emoji/"
    },
    "split_keywords": [
        "emoji"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ef564ddf8b36aa4b52077045b17ffb8958f3360b250df4143d1482d9d5bb54d5",
                "md5": "33d58be9c25ea02bdbae9ebf743856bf",
                "sha256": "fcc936bf374b1aec67dda5303ae99710ba88cc9cdce2d1a71c5f2204e6d78799"
            },
            "downloads": -1,
            "filename": "emoji-2.14.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "33d58be9c25ea02bdbae9ebf743856bf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 586897,
            "upload_time": "2024-10-04T08:04:49",
            "upload_time_iso_8601": "2024-10-04T08:04:49.464753Z",
            "url": "https://files.pythonhosted.org/packages/ef/56/4ddf8b36aa4b52077045b17ffb8958f3360b250df4143d1482d9d5bb54d5/emoji-2.14.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1364812d7e2ae0ac2ade0d6583f911f99240c80f700afbe8391df10e547f564d",
                "md5": "c5e4a80355a0d0aa35a0e06fb49df3f2",
                "sha256": "f68ac28915a2221667cddb3e6c589303c3c6954c6c5af6fefaec7f9bdf72fdca"
            },
            "downloads": -1,
            "filename": "emoji-2.14.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c5e4a80355a0d0aa35a0e06fb49df3f2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 593932,
            "upload_time": "2024-10-04T08:04:51",
            "upload_time_iso_8601": "2024-10-04T08:04:51.773957Z",
            "url": "https://files.pythonhosted.org/packages/13/64/812d7e2ae0ac2ade0d6583f911f99240c80f700afbe8391df10e547f564d/emoji-2.14.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-04 08:04:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "carpedm20",
    "github_project": "emoji",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "emoji"
}
        
Elapsed time: 0.35227s