release: v1.0.0

- launch of the app
- local api
- plenty of languages
- emojipedia links

Author: BenjaminOddou

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Benjamin Oddou
+Copyright (c) 2023-present Benjamin Oddou
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,105 @@
+<img src="public/icon_dark_mode.webp#gh-dark-mode-only" alt="logo-dark" height="55"/>
+<img src="public/icon_light_mode.webp#gh-light-mode-only" alt="logo-light" height="55"/>
+
+[![made with heart by Benjamin Oddou](https://img.shields.io/badge/made%20with%20%E2%99%A5%20by-benjamin%20oddou-ff2f35.svg?style=flat)](https://github.com/BenjaminOddou)
+[![saythanks](https://img.shields.io/badge/say-thanks-bf0001.svg?style=flat)](https://saythanks.io/to/BenjaminOddou)
+[![Python 3.7+](https://img.shields.io/badge/python-3.7+-7f0000.svg)](https://www.python.org/downloads/macos/)
+
+Welcome to the Alfred Emoji Wine repository: **An Alfred Workflow** ✨
+
+## ✅ Prerequisites
+
+* MacOS.
+* Alfred 5. Note that the [Alfred Powerpack](https://www.alfredapp.com/powerpack/) is required to use workflows.
+* Requires **python 3.7** or above.
+
+## 🏎️ Data sources
+
+This workflow combines multiple sources (see below) to build a local JSON API (`~/Library/Caches/com.runningwithcrayons.Alfred/Workflow Data/com.benjamino.emoji_wine`) along with an icons folder with base64 png images (≊1-4Ko per image).
+
+List of sources :
+* [Full list of latest emojis](https://unicode.org/Public/emoji/latest/emoji-test.txt) - Used to grab the full list of emojis
+* [Classic emojis images](https://unicode.org/emoji/charts/full-emoji-list.html) - Used to grab list of classic emojis images
+* [Skin Tone emojis images](https://unicode.org/emoji/charts/full-emoji-modifiers.html) -  Used to grab list of skin toned emojis images
+* [CLDR Data files annotations](https://raw.githubusercontent.com/unicode-org/cldr/main/common/annotations) - Used to translate of emojis titles and keywords
+* [CLDR Data files annotations derived](https://raw.githubusercontent.com/unicode-org/cldr/main/common/annotationsDerived) - Used to translate of emojis titles and keywords
+
+## ⬇️ Installation
+
+1. [Download the workflow](https://github.com/BenjaminOddou/alfred-emoji-wine/releases/latest)
+2. Double click the `.alfredworkflow` file to install
+
+## 🧰 Setup the workflow
+
+Install Python 3.7 or above. Check your version with :
+
+```shell
+python --version
+```
+
+## 🧙‍♂️ Invoke the workflow
+
+There is 2 flows in this workflow :
+
+1. The first one allows you to display emojis. It can be triggered by writing `wine` keyword.
+2. The second allows you to build the local api according the selected language. You can invoke this flow with the `harvest` keyword.
+
+You can edit these triggers (flagged with a `🕹️` symbol) in the user configuration panel.
+
+## 🤖 Usage of the workflow
+
+### Setup variables
+
+1. `🌐 Language` : select the language you prefer. Here is the full list of supported languages :
+
+| Language        | ISO 639-1 | Emojipedia link |
+| --------------- | --------- | --------------- |
+| 🇬🇧 English    | en        | 🟢             |
+| 🇫🇷 Français   | fr        | 🟢             |
+| 🇪🇸 Español    | es        | 🟢             |
+| 🇵🇹 Português  | pt        | 🟢             |
+| 🇮🇹 Italiano   | it        | 🟢             |
+| 🇩🇪 Deutsch    | de        | 🟢             |
+| 🇳🇱 Nederlands | nl        | 🟢             |
+| 🇳🇴 Norsk      | no        | 🟢             |
+| 🇸🇪 Svenska    | se        | 🟢             |
+| 🇩🇰 Dansk      | dk        | 🟢             |
+| 🇮🇩 Melayu     | ms        | 🟢             |
+| 🇨🇳 中文         | zh        | 🟢            |
+| 🇯🇵 日本語        | ja        | 🟢            |
+| 🇰🇷 한국어        | ko        | 🟢             |
+| 🇮🇳 हिंदी      | hi        | 🔴              |
+| 🇮🇳 मराठी      | mr        | 🔴              |
+| 🇮🇳 తెలుగు     | te        | 🔴              |
+| 🇧🇩 বাংলা      | bn        | 🔴              |
+| 🇱🇰 தமிழ்      | ta        | 🔴              |
+
+> All emojis aren't translated in all languages. Some languages doesn't have an emojipedia link issue.
+
+If you wish to use another language, open a GitHub issue [here](https://github.com/BenjaminOddou/alfred-emoji-wine/issues/new).
+
+1. `🎷 Notification sound` : personalize the sound of the workflow notification.
+
+### Search an emoji
+
+Trigger the workflow with `wine` keyword and search for an your emoji in the selected language.
+
+![search](public/search.webp)
+
+### Workflow actions
+
+1. Press ⏎ on the selected emoji to copy it to the clipboard.
+2. Press ⌘⏎ on the selected emoji to paste it to the frontmost application.
+3. Press ⌥⏎ on the selected emoji to copy its shortcut name (`:wine_glass:` ⇒ 🍷).
+4. Press ⇧⏎ on the selected emoji to open its emojipedia page in the selected language.
+
+### Refresh the API
+
+Use the `harvest` keyword to display the local API info and to refresh it.
+
+![harvest](public/harvest.webp)
+
+
+## ⚖️ License
+
+[MIT License](LICENSE) © Benjamin Oddou

public/harvest.webp

@@ -0,0 +1,84 @@
+import os
+import re
+import sys
+sys.path.insert(0, './lib')
+import base64
+import json
+import time
+import datetime
+from bs4 import BeautifulSoup
+from io import BytesIO
+from urllib import request
+import xml.etree.ElementTree as ET
+from utils import api_file_path, cache_folder_path, icons_folder_path, display_notification, language
+
+display_notification('⏳ Please wait !', 'Emojis data is beeing gathered, this can take some time...')
+time.sleep(0.2)
+
+for folder in [cache_folder_path, icons_folder_path]:
+    if not os.path.exists(folder):
+        os.mkdir(folder)
+
+try:
+    img_urls = ['https://unicode.org/emoji/charts/full-emoji-list.html', 'https://unicode.org/emoji/charts/full-emoji-modifiers.html']
+    for url in img_urls:
+        img_response = request.urlopen(url).read().decode('utf-8')
+        soup = BeautifulSoup(img_response, 'html.parser')
+        rows = soup.find_all('tr')
+        for row in rows[1:]:
+            cols = row.find_all('td')
+            if cols:
+                img_tag = cols[3].find('img')
+                if img_tag:
+                    img_src = img_tag.get('src').split(',')[1]
+                    img_data = BytesIO(base64.b64decode(img_src))
+                    file_name = f'{cols[-1].text.replace("⊛", "").replace(":", "").strip()}.png'
+                    file_path = os.path.join(icons_folder_path, file_name)
+                    with open(file_path, 'wb') as file:
+                        file.write(img_data.getvalue())
+
+    api_url = 'https://unicode.org/Public/emoji/latest/emoji-test.txt'
+    api_response = request.urlopen(api_url).read().decode('utf-8')
+    lines = [line.strip() for line in api_response.split('\n') if ('; fully-qualified' in line) or ('; component' in line)]
+    
+    lang_url_1 = f'https://raw.githubusercontent.com/unicode-org/cldr/main/common/annotationsDerived/{language}.xml'
+    lang_url_2 = f'https://raw.githubusercontent.com/unicode-org/cldr/main/common/annotations/{language}.xml'
+    lang_response_1 = request.urlopen(lang_url_1).read().decode('utf-8')
+    lang_response_2 = request.urlopen(lang_url_2).read().decode('utf-8')
+
+    root = ET.fromstring(lang_response_1)
+    root.extend(ET.fromstring(lang_response_2))
+
+    items = []
+    for line in lines:
+        array = re.split(r'\bfully-qualified\b|\bcomponent\b', line)[1].strip().split(' ', 3)
+        emoji, name = array[1], array[-1]
+        trim_emoji = re.sub('\uFE0F', '', emoji)
+        for elem in root:
+            keywords_list = elem.find(f"./annotation[@cp='{trim_emoji}']")
+            title = elem.find(f"./annotation[@cp='{trim_emoji}'][@type='tts']")
+            keywords = None
+            if keywords_list is not None and title is not None:
+                title = title.text
+                keywords = keywords_list.text.split(' | ')
+                break
+        items.append({
+            'name': name,
+            'emoji': emoji,
+            'title': title,
+            'keywords': keywords
+        })
+
+    with open('json/lang.json') as file:
+        langs = json.load(file)
+    for item in langs:
+        if item["value"] == language:
+            lang = item["title"]
+            break
+    info = {'time': datetime.datetime.now().strftime("%d-%m-%Y %H:%M:%S"), 'lang': {'title': lang, 'value': language}}
+    with open(api_file_path, 'w', encoding='utf-8') as file:
+        json.dump({'info': info, 'items': items}, file, ensure_ascii=False, indent=4)
+
+    display_notification('✅ Success !', 'Data updated. You can search emojis.')
+except:
+    display_notification('🚨 Error !', 'Something went wrong, check your internet connexion or report a GitHub issue')

public/icon_dark_mode.webp

@@ -0,0 +1,38 @@
+import json
+from utils import api
+
+data = api()
+items = []
+
+if data:
+    num_object = len(data['items'])
+    items = [
+        {
+            'title': 'Refresh the API',
+            'subtitle': 'Press ⏎ to grab emoji data from unicode.org',
+            'arg': '_api',
+            'icon': {
+                'path': 'icons/sync.webp',
+            },
+        },
+        {
+            'title': 'API information',
+            'subtitle': f'Last update : {data["info"]["time"]} ǀ {num_object} Emojis ǀ {data["info"]["lang"]["title"]}',
+            'valid': False,
+            'icon': {
+                'path': 'icons/info.webp',
+            },
+        }
+    ]
+else:
+    items.append({
+        'title': 'No API detected',
+        'subtitle': 'Press ⏎ to grab emoji data from unicode.org',
+        'arg': '_api',
+        'icon': {
+            'path': 'icons/info.webp',
+        },
+    })
+
+
+print(json.dumps({'items': items}))