# Glyphoji
Modern **hieroglyphs** in the terminal.
```Python
>>> from glyphoji import glyph
>>> print(f"This {glyph.burger} is a burger!")
This đ is a burger!
```
[](https://github.com/rly0nheart/glyphoji/actions/workflows/codeql.yml)
[](https://github.com/rly0nheart/glyphoji/actions/workflows/python-publish.yml)
**Glyphoji** is a friendly cross-platform emoji library that brings a touch of fun to your terminal experience! đ With a collection of over 2,500 old + new emojis, your code can now smile, wink, and dance.
Adding visual flair to your code has never been this easy!đ
***
# âšī¸ Getting Started
## âŦī¸ Installation
### đĻ PyPI
Glyphoji can be installed from PyPI with *pip* by running the command:
```
$ pip install glyphoji
```
### đ§ Dev from GitHub
Intstalling the unreleased dev version of Glyphoji can also be done with *pip*:
```
$ pip install git+https://github.com/rly0nheart/glyphoji.git@dev
```
> The unreleased versions might not be stable.
***
## đ Code Examples
### đ Available Glyphs/Emojis
All glyphs/emojis can be printed by accessing the *glyphs* attribute from the *glyph* instance.
```Python
>>> from glyphoji import glyph
>>> print(glyph.glyphs)
đĨ: {'aliases': ['avocado'], 'description': 'An avocado.'}
đ: {'aliases': ['eggplant'], 'description': 'An eggplant.'}
đĨ: {'aliases': ['potato'], 'description': 'A potato.'}
đĨ: {'aliases': ['carrot'], 'description': 'A carrot.'}
đŊ: {'aliases': ['ear_of_corn', 'corn', 'maize'], 'description': 'An ear of corn.'}
đļī¸: {'aliases': ['hot_pepper'], 'description': 'A hot pepper.'}
đĢ: {'aliases': ['bell_pepper'], 'description': 'A bell pepper.'}
...
```
### đ Searching Glyphs
Glyphoji also lets users search for a specific glyph, and returns all results that closely match with the query. The query can be the glyph name/alias or a description of the glyph.
```Python
>>> from glyphoji import glyph
>>> query = "flying saucer"
>>> print(glyph.search(query))
[close matches to `flying saucer`]
đ¸: {'aliases': ['flying_saucer', 'ufo', 'spaceship', 'spacecraft'], 'description': 'A flying saucer.'}
```
### đ Aliases
Some glyphs have aliases or alternate names that can also be used to return the glyph itself:
```Python
>>> from glyphoji import glyph
>>> print(f"This {glyph.hotdog} is a hot dog!")
This đ is a hot dog!
>>> print(f"This {glyph.hot_diggity_dog} is also a hot dog!")
This đ is also a hot dog!
```
```Python
>>> from glyphoji import glyph
>>> print(f"The party was {glyph.fire}")
The party was đĨ
>>> print(f"The party was {glyph.lit}")
The party was đĨ
```
***
<a href="https://www.buymeacoffee.com/_rly0nheart"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=_rly0nheart&button_colour=40DCA5&font_colour=ffffff&font_family=Comic&outline_colour=000000&coffee_colour=FFDD00" /></a>
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/glyphoji",
"name": "glyphoji",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Richard Mwewa",
"author_email": "rly0nheart@duck.com",
"download_url": "https://files.pythonhosted.org/packages/58/5f/ea9b77ca4a823bff8f90e8ab34baf2be74f70e2318dbb95ed61f8f4d450f/glyphoji-0.3.1.tar.gz",
"platform": null,
"description": "\n\n# Glyphoji\nModern **hieroglyphs** in the terminal.\n```Python\n>>> from glyphoji import glyph\n>>> print(f\"This {glyph.burger} is a burger!\")\nThis \ud83c\udf54 is a burger!\n```\n\n\n[](https://github.com/rly0nheart/glyphoji/actions/workflows/codeql.yml)\n[](https://github.com/rly0nheart/glyphoji/actions/workflows/python-publish.yml)\n\n**Glyphoji** is a friendly cross-platform emoji library that brings a touch of fun to your terminal experience! \ud83c\udf89 With a collection of over 2,500 old + new emojis, your code can now smile, wink, and dance. \nAdding visual flair to your code has never been this easy!\ud83d\ude0e\n***\n\n# \u2139\ufe0f Getting Started\n## \u2b07\ufe0f Installation\n### \ud83d\udce6 PyPI\nGlyphoji can be installed from PyPI with *pip* by running the command:\n```\n$ pip install glyphoji\n```\n### \ud83d\udea7 Dev from GitHub\nIntstalling the unreleased dev version of Glyphoji can also be done with *pip*:\n```\n$ pip install git+https://github.com/rly0nheart/glyphoji.git@dev\n```\n> The unreleased versions might not be stable.\n***\n## \ud83d\udcd6 Code Examples\n### \ud83d\ude00 Available Glyphs/Emojis\nAll glyphs/emojis can be printed by accessing the *glyphs* attribute from the *glyph* instance.\n```Python\n>>> from glyphoji import glyph\n>>> print(glyph.glyphs)\n\ud83e\udd51: {'aliases': ['avocado'], 'description': 'An avocado.'}\n\ud83c\udf46: {'aliases': ['eggplant'], 'description': 'An eggplant.'}\n\ud83e\udd54: {'aliases': ['potato'], 'description': 'A potato.'}\n\ud83e\udd55: {'aliases': ['carrot'], 'description': 'A carrot.'}\n\ud83c\udf3d: {'aliases': ['ear_of_corn', 'corn', 'maize'], 'description': 'An ear of corn.'}\n\ud83c\udf36\ufe0f: {'aliases': ['hot_pepper'], 'description': 'A hot pepper.'}\n\ud83e\uded1: {'aliases': ['bell_pepper'], 'description': 'A bell pepper.'}\n...\n```\n\n### \ud83d\udd0d Searching Glyphs\nGlyphoji also lets users search for a specific glyph, and returns all results that closely match with the query. The query can be the glyph name/alias or a description of the glyph.\n\n```Python\n>>> from glyphoji import glyph\n>>> query = \"flying saucer\"\n>>> print(glyph.search(query))\n[close matches to `flying saucer`]\n\ud83d\udef8: {'aliases': ['flying_saucer', 'ufo', 'spaceship', 'spacecraft'], 'description': 'A flying saucer.'}\n```\n\n### \ud83d\udcdb Aliases\nSome glyphs have aliases or alternate names that can also be used to return the glyph itself:\n```Python\n>>> from glyphoji import glyph\n>>> print(f\"This {glyph.hotdog} is a hot dog!\")\nThis \ud83c\udf2d is a hot dog!\n>>> print(f\"This {glyph.hot_diggity_dog} is also a hot dog!\")\nThis \ud83c\udf2d is also a hot dog!\n```\n\n\n```Python\n>>> from glyphoji import glyph\n>>> print(f\"The party was {glyph.fire}\")\nThe party was \ud83d\udd25\n>>> print(f\"The party was {glyph.lit}\")\nThe party was \ud83d\udd25\n```\n***\n<a href=\"https://www.buymeacoffee.com/_rly0nheart\"><img src=\"https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=_rly0nheart&button_colour=40DCA5&font_colour=ffffff&font_family=Comic&outline_colour=000000&coffee_colour=FFDD00\" /></a>\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Modern hieroglyphs in the terminal.",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://pypi.org/project/glyphoji",
"Repository": "https://github.com/rly0nheart/glyphoji"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eae6b3d62b10615da3da3cb32d1666df6f9df029ceebfa2999ac384a8f7baaea",
"md5": "03ff36511e3510b44bde1ad13a3d488c",
"sha256": "efdbf83702b04a16113cb2227365979d533a8106f5c7b68631f00ee888394c10"
},
"downloads": -1,
"filename": "glyphoji-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "03ff36511e3510b44bde1ad13a3d488c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 44839,
"upload_time": "2023-10-02T13:49:52",
"upload_time_iso_8601": "2023-10-02T13:49:52.558655Z",
"url": "https://files.pythonhosted.org/packages/ea/e6/b3d62b10615da3da3cb32d1666df6f9df029ceebfa2999ac384a8f7baaea/glyphoji-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "585fea9b77ca4a823bff8f90e8ab34baf2be74f70e2318dbb95ed61f8f4d450f",
"md5": "e7858cd297014ab441fa7955325a6d06",
"sha256": "8f1b00d2284891ebb18185ba173fdcff1966c014af5894337efc39760e905fcd"
},
"downloads": -1,
"filename": "glyphoji-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "e7858cd297014ab441fa7955325a6d06",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 45008,
"upload_time": "2023-10-02T13:49:54",
"upload_time_iso_8601": "2023-10-02T13:49:54.483466Z",
"url": "https://files.pythonhosted.org/packages/58/5f/ea9b77ca4a823bff8f90e8ab34baf2be74f70e2318dbb95ed61f8f4d450f/glyphoji-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-02 13:49:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rly0nheart",
"github_project": "glyphoji",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "glyphoji"
}
JSON
