# EmojiStore
Free unicode emojis ready to use !
This package contains a total of 1851 emojis grouped in 8 categories.
# Installation
Install with pip
`pip install EmojiStore`
or
`pip3 install EmojiStore`
# Usage
It all starts by importing the package
```python
import EmojiStore
```
### Get all emojis
You can get all available emojis by calling the `get_all()` method.
```python
emojis = EmojiStore.get_all()
```
Notice that every time you are retrieving emojis, you get an iterator of **namedtuple** elements (emojis).
Each emoji have the following properties :
- **category** : The category from which belongs the emoji
- **emoji** : The emoji character
- **alias** : The emoji short code
- **description** : The emoji description
- **unicode** : A list of Unicode composing the emoji
```commandline
>>> ...
>>> first_emoji = emojis[0]
>>> print(first_emoji.category)
smileys_and_people
>>> print(first_emoji.emoji)
😀
>>> print(first_emoji.alias)
grinning_face
>>> print(first_emoji.description)
grinning face
>>> print(first_emoji.unicode)
['U+1F600']
```
### Get emoji categories
You can get all available categories by calling the `get_categories()` method.
This method returns a set of all categories :
- smileys_and_people
- animals_and_nature
- food_and_drink
- travel_and_places
- activities
- objects
- symbols
- flags
```python
categories = EmojiStore.get_categories()
print(categories)
```
Output :
```
{'animals_and_nature', 'food_and_drink', 'symbols', 'flags', 'travel_and_places', 'smileys_and_people', 'objects', 'activities'}
```
### Get all emojis from a specific category
```python
import EmojiStore
smileys = EmojiStore.get_by_category("smileys_and_people")
```
# Credits
All the emojis in this package where generated from https://www.webfx.com/tools/emoji-cheat-sheet
Raw data
{
"_id": null,
"home_page": "https://antaresmugisho.vercel.app/",
"name": "EmojiStore",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,emoji,sticker,mood",
"author": "Antares Mugisho",
"author_email": "antaresmugisho@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/42/e4/767e828336780960ed48d6d67d4db6d3bad811af0a4a5c7a9e3ba6947a97/EmojiStore-1.0.2.tar.gz",
"platform": null,
"description": "# EmojiStore\nFree unicode emojis ready to use !\nThis package contains a total of 1851 emojis grouped in 8 categories.\n\n# Installation\nInstall with pip\n\n`pip install EmojiStore`\n\nor\n\n`pip3 install EmojiStore`\n\n# Usage\nIt all starts by importing the package\n\n```python\nimport EmojiStore\n```\n### Get all emojis\nYou can get all available emojis by calling the `get_all()` method.\n\n```python\nemojis = EmojiStore.get_all()\n```\n\nNotice that every time you are retrieving emojis, you get an iterator of **namedtuple** elements (emojis).\nEach emoji have the following properties : \n- **category** : The category from which belongs the emoji\n- **emoji** : The emoji character\n- **alias** : The emoji short code\n- **description** : The emoji description\n- **unicode** : A list of Unicode composing the emoji\n\n```commandline\n>>> ...\n>>> first_emoji = emojis[0]\n>>> print(first_emoji.category)\nsmileys_and_people\n\n>>> print(first_emoji.emoji)\n\ud83d\ude00\n\n>>> print(first_emoji.alias)\ngrinning_face\n\n>>> print(first_emoji.description)\ngrinning face\n\n>>> print(first_emoji.unicode)\n['U+1F600']\n```\n\n### Get emoji categories\nYou can get all available categories by calling the `get_categories()` method. \nThis method returns a set of all categories :\n- smileys_and_people\n- animals_and_nature\n- food_and_drink\n- travel_and_places\n- activities\n- objects\n- symbols\n- flags\n\n```python\ncategories = EmojiStore.get_categories()\nprint(categories)\n```\n\nOutput :\n```\n{'animals_and_nature', 'food_and_drink', 'symbols', 'flags', 'travel_and_places', 'smileys_and_people', 'objects', 'activities'}\n```\n\n### Get all emojis from a specific category\n\n```python\nimport EmojiStore\n\nsmileys = EmojiStore.get_by_category(\"smileys_and_people\")\n```\n\n# Credits\nAll the emojis in this package where generated from https://www.webfx.com/tools/emoji-cheat-sheet\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Free unicode emojis ready to use !",
"version": "1.0.2",
"project_urls": {
"Download": "https://github.com/AntaresMugisho/EmojiStore/archive/refs/tags/v1.0-beta.tar.gz",
"Homepage": "https://antaresmugisho.vercel.app/"
},
"split_keywords": [
"python",
"emoji",
"sticker",
"mood"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8779b657fdb191ebbe68b81a90d33f1bdcb250c40b8ec33dabc211fedd0757b9",
"md5": "3c22cfd3ca87dca58ad14e2036bdf71a",
"sha256": "24b1e4e0944c99e97c47acf435463cb590124caf3ea02f6c796538fd38b42c94"
},
"downloads": -1,
"filename": "EmojiStore-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3c22cfd3ca87dca58ad14e2036bdf71a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 35537,
"upload_time": "2023-10-23T10:24:57",
"upload_time_iso_8601": "2023-10-23T10:24:57.849581Z",
"url": "https://files.pythonhosted.org/packages/87/79/b657fdb191ebbe68b81a90d33f1bdcb250c40b8ec33dabc211fedd0757b9/EmojiStore-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "42e4767e828336780960ed48d6d67d4db6d3bad811af0a4a5c7a9e3ba6947a97",
"md5": "d34d7cd68bdc4b90bfdb3c244946a419",
"sha256": "4ef7906166b04f459ce4c1141203ff341030ec229ff74d06fbed68c9f81346bd"
},
"downloads": -1,
"filename": "EmojiStore-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "d34d7cd68bdc4b90bfdb3c244946a419",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34858,
"upload_time": "2023-10-23T10:25:00",
"upload_time_iso_8601": "2023-10-23T10:25:00.313803Z",
"url": "https://files.pythonhosted.org/packages/42/e4/767e828336780960ed48d6d67d4db6d3bad811af0a4a5c7a9e3ba6947a97/EmojiStore-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-23 10:25:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AntaresMugisho",
"github_project": "EmojiStore",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "emojistore"
}
JSON
