symjoy 2.6.0

A structured, metadata-driven Unicode symbol engine for Python.

Symjoy

Version	Highlights
v2.6.0	Indexed search engine
v2.5.0	Metadata-driven architecture
v2.1.0	Helper APIs & improved search
v2.0.0	Structured category API

A structured, metadata-driven Unicode symbol engine for Python.

symjoy provides clean, consistent, and intelligent access to Unicode characters including:

• Emojis 😄
• Symbols ♥
• Arrows →
• Mathematical symbols π
• Currency signs ₹
• Miscellaneous icons ☀

It is designed for chat applications, games, educational tools, financial apps, and any Python project requiring Unicode characters.

---

✨ Key Features

• JSON-backed data architecture.
• Lazy-loaded registry.
• Automatic keyword enrichment.
• Semantic relationship graph.
• Multilingual alias support.
• Indexed search engine for fast lookups.
• Deterministic search ordering.
• Category-isolated APIs.
• Backward compatible with v2.x.

---

📦 Installation

pip install symjoy

Required Python version: 3.12+

🚀 Basic Usage

from symjoy import emoji, symbols, arrows, math, currency, misc, search

print(emoji.get("smile"))      # 😄
print(symbols.get("heart"))    # ♥
print(arrows.get("right"))     # →
print(math.get("pi"))          # π
print(currency.get("rupee"))   # ₹
print(misc.get("sun"))         # ☀

print(emoji.random())          # Random emoji

📚 Category API

Each category exposes a consistent interface:

get(name) -> str | None
random() -> str
list() -> list[str]
items() -> dict[str, str]
related(name) -> list[dict]

Example:

from symjoy import emoji

print(emoji.list())
print(emoji.related("broken_heart"))

🔎 Intelligent Search

Search across all categories:

from symjoy import search

results = search("heart")

Search is ranked by:

1. Exact name match.
2. Prefix name match.
3. Keyword match.
4. Alias match.
5. Substring fallback.

🧠 Metadata Engine (v2.5.0)

v2.5.0 introduces a major internal upgrade:

• JSON-driven data storage
• Runtime metadata enrichment
• Automatic keyword generation
• Token-based semantic relationship graph
• Fully category-agnostic registry

Example:

emoji.related("heart")
search("joy")

⚡ Indexed Search Engine (v2.6.0)

v2.6.0 introduces an internal symbol index engine that significantly improves search performance.

The registry now builds internal indexes for:

• symbol names.
• keywords.
• aliases.
• name tokens.

This allows search queries to avoid scanning the entire symbol registry and instead perform indexed lookups.

Benefits:

• faster search performance.
• scalable architecture for larger Unicode datasets.
• improved metadata-based queries.

🔁 Backward Compatibility (v1.x)

Version 2.x still supports legacy v1-style access:

from symjoy import emojis
print(emojis["smile"])

⚠️ This usage is deprecated and will be removed in symjoy v3.0.0.

📖 Documentation

📜 Changelog

🔄 Migration Guide

🏗 Architecture Overview

📁 File Structure

Project Links

If any issue with the package you can contact here:

• Email: [e-mail]

The source code is available on GitHub

• Github: https://github.com/vishwanathdvgmm/symjoy
• Github issues: https://github.com/vishwanathdvgmm/symjoy/issues

The link for the package in pypi.org is:

• Pypi: https://pypi.org/project/symjoy/

License: MIT