186 lines
5.2 KiB
Plaintext
186 lines
5.2 KiB
Plaintext
Metadata-Version: 2.1
|
||
Name: emoji
|
||
Version: 2.10.0
|
||
Summary: Emoji for Python
|
||
Home-page: https://github.com/carpedm20/emoji/
|
||
Author: Taehoon Kim, Kevin Wurster
|
||
Author-email: carpedm20@gmail.com
|
||
License: New BSD
|
||
Keywords: emoji
|
||
Classifier: Development Status :: 5 - Production/Stable
|
||
Classifier: Intended Audience :: Developers
|
||
Classifier: Intended Audience :: Information Technology
|
||
Classifier: License :: OSI Approved :: BSD License
|
||
Classifier: Operating System :: OS Independent
|
||
Classifier: Programming Language :: Python :: 3
|
||
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: Programming Language :: Python :: Implementation :: CPython
|
||
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
||
Classifier: Programming Language :: Python
|
||
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
|
||
Classifier: Topic :: Multimedia :: Graphics :: Presentation
|
||
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
||
Classifier: Typing :: Typed
|
||
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
|
||
License-File: LICENSE.txt
|
||
Provides-Extra: dev
|
||
Requires-Dist: pytest ; extra == 'dev'
|
||
Requires-Dist: coverage ; extra == 'dev'
|
||
Requires-Dist: coveralls ; extra == 'dev'
|
||
|
||
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/get_codes_from_unicode_emoji_data_files.py`` is used to generate
|
||
``unicode_codes/data_dict.py``. 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/>`__
|
||
and prints the contents to ``stdout`` as a Python dictionary. For more
|
||
information take a look in the `utils/README.md <utils/README.md>`__ file.
|
||
|
||
|
||
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>`__
|