glyphoji 0.3.1
Modern hieroglyphs in the terminal.
License: MIT
Requires Python: >=3.7,<4.0

![glyphoji-snake](https://github.com/rly0nheart/glyphoji/assets/74001397/1b32fe5a-ef9a-48b6-89f7-0e0bd647704c)

# Glyphoji
Modern **hieroglyphs** in the terminal.
```Python
>>> from glyphoji import glyph
>>> print(f"This {glyph.burger} is a burger!")
This 🍔 is a burger!
```
![Python](https://img.shields.io/badge/python-3670A0?style=flat&logo=python&logoColor=ffdd54)
![PyPI - Downloads](https://img.shields.io/pypi/dm/glyphoji?logo=pypi)
[![CodeQL](https://github.com/rly0nheart/glyphoji/actions/workflows/codeql.yml/badge.svg)](https://github.com/rly0nheart/glyphoji/actions/workflows/codeql.yml)
[![Upload Python Package](https://github.com/rly0nheart/glyphoji/actions/workflows/python-publish.yml/badge.svg)](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>

![me](https://github.com/rly0nheart/glyphoji/assets/74001397/e202c4c1-9a69-40c4-a4da-1e95befb08ee)![python-powered](https://github.com/rly0nheart/glyphoji/assets/74001397/797adebc-2b98-41bc-9019-2b0079fc32dc)