Skip to main content

Modern hieroglyphs in the terminal.

Project description

hieroglyph Modern hieroglyphs in the terminal.

Python CodeQL Upload Python Package

Glyphoji is a simple and lightweight emoji library that lets you easily print and format emojis anywhere in the terminal.


⬇️ Installation

🐍 PyPI

Glyphoji can be installed from PyPI with pip by running the command;

pip install glyphoji

❔ GitHub

Intstalling the unreleased version of Glyphoji can also be done with pip, unless you want to build it yourself from source.

pip install git+https://github.com/rly0nheart/glyphoji.git

📖 Code Examples

🔣 Available emojis

All emojis can be printed by calling the glyphs attribute from glyph

from glyphoji import glyph


print(glyph.glyphs)

Output;

🥑: {'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.'}
...

📄 Formatting glyphs in strings

A Gyphoji glyph/emoji can be formatted and used anywhere. Glyphs can be called from glyph by specifying the glyph name or alias as the attribute.

from glyphoji import glyph


print(f"This {glyph.burger} is a burger!")

Output;

This 🍔 is a burger!

🔍 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 or a description of the glyph.

from glyphoji import glyph


query = "flying saucer"
print(glyph.search(query))

Output;

🛸: {'aliases': ['flying_saucer', 'ufo', 'spaceship', 'spacecraft'], 'description': 'A flying saucer.'}

Made with 🖤 by Richard Mwewa

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

glyphoji-0.2.1.tar.gz (38.4 kB view hashes)

Uploaded Source

Built Distribution

glyphoji-0.2.1-py3-none-any.whl (38.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page