{"id":22955258,"url":"https://github.com/happycod3r/emojix","last_synced_at":"2025-04-02T00:41:51.416Z","repository":{"id":188535539,"uuid":"678849492","full_name":"happycod3r/emojix","owner":"happycod3r","description":"A small Unicode Emoji picker and database GUI app built with Python3","archived":false,"fork":false,"pushed_at":"2023-09-03T19:54:35.000Z","size":3558,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-07T16:16:53.105Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/happycod3r.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-15T14:24:08.000Z","updated_at":"2023-08-18T05:41:26.000Z","dependencies_parsed_at":"2024-12-14T16:29:01.820Z","dependency_job_id":"e5a2d514-3443-4799-b694-73fef0cc5a99","html_url":"https://github.com/happycod3r/emojix","commit_stats":null,"previous_names":["happycod3r/emojipy","happycod3r/emoji-ext","happycod3r/emojix"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/happycod3r%2Femojix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/happycod3r%2Femojix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/happycod3r%2Femojix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/happycod3r%2Femojix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/happycod3r","download_url":"https://codeload.github.com/happycod3r/emojix/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246735343,"owners_count":20825223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-14T16:28:49.587Z","updated_at":"2025-04-02T00:41:51.395Z","avatar_url":"https://github.com/happycod3r.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Emojix (Emoji Extended)\r\n\r\n## [About](#about)\r\n***Emoji-x*** or ***Emojix*** is built on top of the existing ***[Emoji](https://pypi.org/project/emoji/)*** module for Python. It aims to extend it with new functions and a more robust EMOJI_DATA dictionary.\r\n\r\n## [Module Contents](#module-contents)\r\nThe following functions and variables are available through the emojix module.\r\n\r\n| **Legacy Emoji Functions \u0026 Variables**                                                                           |                                                              |\r\n|-----------------------------------------------------------------------------------------------|--------------------------------------------------------------|\r\n| [`emojize()`](https://carpedm20.github.io/emoji/docs/#emoji.emojize)                          | Replace emoji shortcodes with the corresponding emojis                    |\r\n| [`demojize()`](https://carpedm20.github.io/emoji/docs/#emoji.demojize)                        | Replace emojis with the corresponding emoji shortcodes                  |\r\n| [`replace_emoji()`](https://carpedm20.github.io/emoji/docs/#emoji.replace_emoji)              | Like str.replace() but only replaces emojis\r\n| [`emoji_list()`](https://carpedm20.github.io/emoji/docs/#emoji.emoji_list)                    | Returns a list of all emojis in a string\r\n| [`distinct_emoji_list()`](https://carpedm20.github.io/emoji/docs/#emoji.distinct_emoji_list)  | Returns a list of unique emojis in a string\r\n| [`emoji_count()`](https://carpedm20.github.io/emoji/docs/#emoji.emoji_count)                  | Returns the number of emojis in a string\r\n| [`is_emoji()`](https://carpedm20.github.io/emoji/docs/#emoji.is_emoji)                        | Returns true if the given char is an emoji and false otherwise\r\n| [`version()`](https://carpedm20.github.io/emoji/docs/#emoji.version)                          | Returns the version of the given emoji\r\n\r\n| **Emoji-extended Functions \u0026 Variables**                                                                           |                                                              |\r\n|-----------------------------------------------------------------------------------------------|--------------------------------------------------------------|\r\n| [`category_exists()`](https://happycod3r.github.io/emojix/docs/#emojix.category_exists)         | Returns true if the given category exists and False otherwise\r\n| [`category()`](https://happycod3r.github.io/emojix/docs/#emojix.category)                      | Returns the category of the given emoji\r\n| [`get_all_categories()`](https://happycod3r.github.io/emojix/docs/#emojix.get_all_categories)  | Returns a dict of all emoji categories and IDs\r\n| [`top_level_categories()`](https://happycod3r.github.io/emojix/docs/#emojix.top_level_categories) | Returns a list of dicts containg all top level categories\r\n| [`sub_level_categories()`](https://happycod3r.github.io/emojix/docs/#emojix.sub_level_categories) | Returns a list of dicts containg all sub level categories\r\n| [`is_top_level_category()`](https://happycod3r.github.io/emojix/docs/#emojix.is_top_level_category) | Returns True if the category is top-level and false otherwise\r\n| [`parent_category()`](https://happycod3r.github.io/emojix/docs/#emojix.parent_category)          | Returns the parent category of the given emoji\r\n| [`child_categories()`](https://happycod3r.github.io/emojix/docs/#emojix.child_categories)        | Returns a list of dicts containg child categries of the given category \r\n| [`iterate_category()`](https://happycod3r.github.io/emojix/docs/#emojix.iterate_category)        | Iterates over the emojis in a given category\r\n| [`emoji_factory()`](https://happycod3r.github.io/emojix/docs/#emojix.emoji_factory)              | A generator function which iterates over all emojis in EMOJI_DATA and yields each one\r\n| [`get_emojis_in_category()`](https://happycod3r.github.io/emojix/docs/#emojix.get_emojis_in_category)  | Returns a list of dicts of all emojis in a given category\r\n| [`is_emoji_variation()`](https://happycod3r.github.io/emojix/docs/#emojix.is_emoji_variation)        | Returns True if the given emoji is a variation (contains a zwj)\r\n| [`get_all_emoji_variants()`](https://happycod3r.github.io/emojix/docs/#emojix.get_all_emoji_variants) | Returns a list of dicts containg all emoji variants \r\n| [`emoji_to_unicode()`](https://happycod3r.github.io/emojix/docs/#emojix.emoji_to_unicode)    | Returns the Unicode notation of a given emoji\r\n| [`emoji_name()`](https://happycod3r.github.io/emojix/docs/#emojix.emoji_name)      | Returns the name or shortcode of a given emoji\r\n| [`get_emoji_by_name()`](https://happycod3r.github.io/emojix/docs/#emojix.get_emoji_by_name)        | Returns an the emoji that corresponds to the given name\r\n| [`has_zwj()`](https://happycod3r.github.io/emojix/docs/#emojix.has_zwj)        | Returns True if the given emoji contains a zero-width-joiner character\r\n| [`EMOJI_DATA`](https://happycod3r.github.io/emojix/docs/#emojix.EMOJI_DATA)                      | Dict of just under 5,000 emojis and their corresponding data\r\n| [`STATUS`](https://carpedm20.github.io/emoji/docs/#emoji.STATUS)                               | Dict containing the Unicode status values for emojis\r\n| [`CATEGORIES`](https://happycod3r.github.io/emojix/docs/#emojix.CATEGORIES)                     | Dict containing all emoji categories and an assigned category ID\r\n| [`BASIC_EMOJIS`](https://happycod3r.github.io/emojix/docs/#emojix.BASIC_EMOJIS)                 | Dict containing all basic emojis organized by category\r\n| [`KEYCHAIN`](https://happycod3r.github.io/emojix/docs/#emojix.KEYCHAIN)                        | Holds EMOJI_DATA.keys()\r\n| [`CATS_KEYCHAIN`](https://happycod3r.github.io/emojix/docs/#emojix.CATS_KEYCHAIN)        | Holds CATEGORIES.keys()\r\n| [`compile_emoji_data()`](https://happycod3r.github.io/emojix/docs/#emojix.compile_emoji_data)        | Recompiles data_dict.py which holds EMOJI_DATA\r\n| [`key_chain()`](https://happycod3r.github.io/emojix/docs/#emojix.key_chain)        | Returns EMOJI_DATA.keys(). Use [core.KEYCHAIN](#emojix.KEYCHAIN) instead\r\n| [`categories_key_chain()`](https://happycod3r.github.io/emojix/docs/#emojix.categories_key_chain)        | Returns CATEGORIES.keys(). Use [core.CATS_KEYCHAIN](#emojix.CATS_KEYCHAIN) instead\r\n| [`emoji_data()`](https://happycod3r.github.io/emojix/docs/#emojix.emoji_data)                 | Returns the EMOJI_DATA dictionary\r\n| [`get_emoji_data_for_lang()`](https://happycod3r.github.io/emojix/docs/#emojix.get_emoji_data_for_lang) | Returns and caches emoji data for a specific language\r\n| [`get_emoji_aliases_data()`](https://happycod3r.github.io/emojix/docs/#emojix.get_emoji_aliases_data) | Returns and caches emoji alias data\r\n\r\n---\r\n\r\n## [Documentation](#documentation) \r\n\r\nUse the following guide to build the documentation with [Sphinx](https://www.sphinx-doc.org/).\r\n\r\n```bash\r\ngit clone https://github.com/happycod3r/emojix.git\r\ncd emoji/docs\r\npython -m pip install -r requirements.txt\r\nmake html\r\n```\r\n\r\nCheck for warnings:\r\n\r\n```bash\r\nmake clean\r\nsphinx-build -n -T -b html . _build\r\n```\r\n\r\nTest code in code blocks:\r\n\r\n```bash\r\nmake doctest\r\n```\r\n\r\nTest coverage of documentation:\r\n\r\n```bash\r\nmake coverage\r\n```\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhappycod3r%2Femojix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhappycod3r%2Femojix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhappycod3r%2Femojix/lists"}