glyphoji 0.3.1

Modern hieroglyphs in the terminal.

Glyphoji

Modern hieroglyphs in the terminal.

>>> from glyphoji import glyph
>>> print(f"This {glyph.burger} is a burger!")
This 🍔 is a burger!

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.

>>> 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.

>>> 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:

>>> 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!

>>> from glyphoji import glyph
>>> print(f"The party was {glyph.fire}")
The party was 🔥
>>> print(f"The party was {glyph.lit}")
The party was 🔥

---