Merge pull request #200 from cvzi/readme

Readme and github pages

README.rst

@@ -9,21 +9,21 @@ Example
 
 The entire set of Emoji codes as defined by the `unicode consortium <http://www.unicode.org/Public/emoji/1.0/full-emoji-list.html>`__
 is supported in addition to a bunch of `aliases <http://www.emoji-cheat-sheet.com/>`__.  By
-default, only the official list is enabled but doing ``emoji.emojize(use_aliases=True)`` enables
+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:', use_aliases=True))
+    >> 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"))
+    >>> print(emoji.emojize("Python is fun :red_heart:", variant="emoji_type"))
     Python is fun ❤️ #red heart, not black heart
     >>> print(emoji.is_emoji("👍"))
     True

emoji/__init__.py

@@ -8,9 +8,9 @@
 emoji terminal output for Python.
 
     >>> import emoji
-    >>> print(emoji.emojize('Python is :thumbsup:', use_aliases=True))
+    >>> print(emoji.emojize('Python is :thumbsup:', language='alias'))
     Python is 👍
-    >> print(emoji.emojize('Python is :thumbs_up:'))
+    >>> print(emoji.emojize('Python is :thumbs_up:'))
     Python is 👍
 """
 
@@ -21,7 +21,7 @@
 __all__ = [
     # emoji.core
     'emojize', 'demojize', 'get_emoji_regexp', 'emoji_count', 'emoji_lis',
-    'replace_emoji', 'version',
+    'distinct_emoji_lis', 'replace_emoji', 'version', 'is_emoji',
     # emoji.unicode_codes
     'EMOJI_UNICODE_ENGLISH', 'EMOJI_UNICODE_SPANISH', 'EMOJI_UNICODE_PORTUGUESE',
     'EMOJI_UNICODE_ITALIAN', 'EMOJI_UNICODE_FRENCH', 'EMOJI_UNICODE_GERMAN',

emoji/core.py

@@ -39,7 +39,7 @@ def emojize(
 ):
     """Replace emoji names in a string with unicode codes.
         >>> import emoji
-        >>> print(emoji.emojize("Python is fun :thumbsup:", use_aliases=True))
+        >>> print(emoji.emojize("Python is fun :thumbsup:", language='alias'))
         Python is fun 👍
         >>> print(emoji.emojize("Python is fun :thumbs_up:"))
         Python is fun 👍

utils/gh-pages/generatePages.py

@@ -21,20 +21,18 @@
 OUT_DIR = os.path.abspath(os.path.dirname(__file__))
 TEMPLATE_DIR = os.path.abspath(os.path.dirname(__file__))
 TEMPLATE_FILE = os.path.join(TEMPLATE_DIR, "template.html")
-data = {"defaultListName": 'UNICODE_EMOJI_ENGLISH'}
+data = {"defaultLang": "en"}
 
 languages = {
-    "EMOJI_UNICODE_ENGLISH": emoji.emojize(":United_Kingdom:"),
-    "EMOJI_ALIAS_UNICODE_ENGLISH": emoji.emojize(":United_Kingdom:alias"),
-    "EMOJI_UNICODE_SPANISH": emoji.emojize(":Spain:"),
-    "EMOJI_UNICODE_PORTUGUESE": emoji.emojize(":Portugal:"),
-    "EMOJI_UNICODE_ITALIAN": emoji.emojize(":Italy:"),
-    "EMOJI_UNICODE_FRENCH": emoji.emojize(":France:"),
-    "EMOJI_UNICODE_GERMAN": emoji.emojize(":Germany:")
-}
-language_args = {
-    "EMOJI_ALIAS_UNICODE_ENGLISH": 'language="en", use_aliases=True'
+    "en": emoji.emojize("en :United_Kingdom:"),
+    "alias":  emoji.emojize("alias :United_Kingdom:"),
+    "es": emoji.emojize("es :Spain:"),
+    "pt": emoji.emojize("pt :Portugal:"),
+    "it": emoji.emojize("it :Italy:"),
+    "fr": emoji.emojize("fr :France:"),
+    "de": emoji.emojize("de :Germany:")
 }
+language_args = {}
 
 
 minify_enabled = sys.argv[-1] == '-minify'
@@ -43,35 +41,34 @@
 
 
 print("Collecting emoji data...")
-for code, unicode_emojis in emoji.UNICODE_EMOJI.items():
-    for var_name in emoji.__all__:
-        if var_name == data["defaultListName"]:
-            language_args[var_name] = ""
-        elif unicode_emojis == getattr(emoji, var_name):
-            language_args[var_name] = f'language="{code}"'
-            break
 
 data["lists"] = lists = []
-for var_name in emoji.__all__:
-    if not var_name.startswith(("EMOJI_UNICODE_", "EMOJI_ALIAS_UNICODE_")):
-        continue
+for language in languages:
 
-    var_name_pretty = languages[var_name] if var_name in languages else var_name
-    language_arg = language_args[var_name] if var_name in language_args else "[TODO]"
+    if language in language_args:
+        language_arg = language_args[language]
+    elif language == data["defaultLang"]:
+        language_arg = ''
+    else:
+        language_arg = f'language="{language}"'
 
     emoji_list = []
-    for name, code in getattr(emoji, var_name).items():
-        emoji_list.append({
-            "code": code,
-            "name": name,
-            "unicode": code.encode('ascii', 'backslashreplace').decode('ascii'),
-            "charname": code.encode('ascii', 'namereplace').decode('ascii'),
-            "xml": code.encode('ascii', 'xmlcharrefreplace').decode('ascii')
-        })
+    for code, emoji_data in emoji.EMOJI_DATA.items():
+        if language not in emoji_data:
+            continue
+        names = [emoji_data[language]] if isinstance(emoji_data[language], str) else emoji_data[language]
+        for name in names:
+            emoji_list.append({
+                "code": code,
+                "name": name,
+                "unicode": code.encode('ascii', 'backslashreplace').decode('ascii'),
+                "charname": code.encode('ascii', 'namereplace').decode('ascii'),
+                "xml": code.encode('ascii', 'xmlcharrefreplace').decode('ascii')
+            })
 
     listentry = {
-        "name": var_name,
-        "pretty": var_name_pretty,
+        "name": language,
+        "pretty": languages[language],
         "languageArg": language_arg,
         "emojis": emoji_list
     }
@@ -102,7 +99,7 @@
 print("Render 'index.html' ...")
 # Remove emoji except for default list
 for listentry in lists:
-    if listentry["name"] != data["defaultListName"]:
+    if listentry["name"] != data["defaultLang"]:
         listentry["emojis"] = []
 
 with codecs.open(os.path.join(OUT_DIR, "index.html"), "w", encoding="utf-8") as f:

utils/gh-pages/requirements.txt

@@ -1,2 +1,2 @@
-django>=3.1.0
+django>=4.0.1
 django-htmlmin>=0.11.0

utils/gh-pages/template.html

@@ -21,7 +21,7 @@ <h1>List of all emojis in the <a href="https://github.com/carpedm20/emoji">emoji
   <div class="search"><span class="search_icon">🔍</span><input type="text" id="search_full" placeholder="Search" /></div>
   <br>
   {% for entry in lists %}
-    <input type="checkbox" id="enable_list_{{ entry.name }}" data-name="{{ entry.name }}" {% if entry.name == defaultListName %} checked {% endif %} {% if not entry.emojis %} class="notloaded" {% endif %} title="{{ entry.name }}">
+    <input type="checkbox" id="enable_list_{{ entry.name }}" data-name="{{ entry.name }}" {% if entry.name == defaultLang %} checked {% endif %} {% if not entry.emojis %} class="notloaded" {% endif %} title="{{ entry.name }}">
     <label for="enable_list_{{ entry.name }}" title="{{ entry.name }}">{{ entry.pretty }}</label>
   {% endfor %}
   <br>