README.rst
1Emoji
2=====
3
4Emoji for Python. This project was inspired by `kyokomi <https://github.com/kyokomi/emoji>`__.
5
6
7Example
8-------
9
10The entire set of Emoji codes as defined by the `unicode consortium <http://www.unicode.org/Public/emoji/1.0/full-emoji-list.html>`__
11is supported in addition to a bunch of `aliases <http://www.emoji-cheat-sheet.com/>`__. By
12default, only the official list is enabled but doing ``emoji.emojize(use_aliases=True)`` enables
13both the full list and aliases.
14
15.. code-block:: python
16
17 >> import emoji
18 >> print(emoji.emojize('Python is :thumbs_up:'))
19 Python is ��
20 >> print(emoji.emojize('Python is :thumbsup:', use_aliases=True))
21 Python is ��
22 >> print(emoji.demojize('Python is ��'))
23 Python is :thumbs_up:
24 >>> print(emoji.emojize("Python is fun :red_heart:"))
25 Python is fun ❤
26 >>> print(emoji.emojize("Python is fun :red_heart:",variant="emoji_type"))
27 Python is fun ❤️ #red heart, not black heart
28 >>> print(emoji.is_emoji("��"))
29 True
30
31..
32
33By default, the language is English (``language='en'``) but also supported languages are:
34
35Spanish (``'es'``), Portuguese (``'pt'``), Italian (``'it'``), French (``'fr'``), German (``'de'``)
36
37
38.. code-block:: python
39
40 >> print(emoji.emojize('Python es :pulgar_hacia_arriba:', language='es'))
41 Python es ��
42 >> print(emoji.demojize('Python es ��', language='es'))
43 Python es :pulgar_hacia_arriba:
44 >>> print(emoji.emojize("Python é :polegar_para_cima:", language='pt'))
45 Python é ��
46 >>> print(emoji.demojize("Python é ��", language='pt'))
47 Python é :polegar_para_cima:️
48
49..
50
51Installation
52------------
53
54Via pip:
55
56.. code-block:: console
57
58 $ pip install emoji --upgrade
59
60From master branch:
61
62.. code-block:: console
63
64 $ git clone https://github.com/carpedm20/emoji.git
65 $ cd emoji
66 $ python setup.py install
67
68
69Developing
70----------
71
72.. code-block:: console
73
74 $ git clone https://github.com/carpedm20/emoji.git
75 $ cd emoji
76 $ pip install -e .\[dev\]
77 $ pytest
78
79The ``utils/get-codes-from-unicode-consortium.py`` may help when updating
80``unicode_codes.py`` but is not guaranteed to work. Generally speaking it
81scrapes a table on the Unicode Consortium's website with
82`BeautifulSoup <http://www.crummy.com/software/BeautifulSoup/>`_ and prints the
83contents to ``stdout`` in a more useful format.
84
85
86Links
87-----
88
89**Overview of all emoji:**
90
91`https://carpedm20.github.io/emoji/ <https://carpedm20.github.io/emoji/>`__
92
93(auto-generated list of the emoji that are supported by the current version of this package)
94
95**For English:**
96
97`Emoji Cheat Sheet <http://www.emoji-cheat-sheet.com/>`__
98
99`Official unicode list <http://www.unicode.org/Public/emoji/1.0/full-emoji-list.html>`__
100
101**For Spanish:**
102
103`Unicode list <https://emojiterra.com/es/puntos-de-codigo/>`__
104
105**For Portuguese:**
106
107`Unicode list <https://emojiterra.com/pt/pontos-de-codigo/>`__
108
109**For Italian:**
110
111`Unicode list <https://emojiterra.com/it/punti-di-codice/>`__
112
113**For French:**
114
115`Unicode list <https://emojiterra.com/fr/points-de-code/>`__
116
117**For German:**
118
119`Unicode list <https://emojiterra.com/de/codepoints/>`__
120
121
122Authors
123-------
124
125Taehoon Kim / `@carpedm20 <http://carpedm20.github.io/about/>`__
126
127Kevin Wurster / `@geowurster <http://twitter.com/geowurster/>`__
128
129Maintainer
130----------
131Tahir Jalilov / `@TahirJalilov <https://github.com/TahirJalilov>`__
132