Metadata-Version: 2.4
Name: symjoy
Version: 2.1.0
Summary: The unicode_symbols package is designed to simplify the use of Unicode characters in Python projects. Whether you need emojis for chat applications, symbols for documentation, mathematical symbols for calculations, currency symbols for finance apps, or miscellaneous icons for fun, this package has you covered.
Project-URL: Homepage, https://github.com/vishwanathdvgmm/symjoy
Project-URL: Issues, https://github.com/vishwanathdvgmm/symjoy/issues
Author-email: Vishwanath M M <vishwanathmm2005@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Description-Content-Type: text/markdown

![PyPI](https://img.shields.io/pypi/v/symjoy)
![Python](https://img.shields.io/pypi/pyversions/symjoy)

# Symjoy

**symjoy** is a comprehensive Python package providing easy access to Unicode characters, including **emojis, symbols, arrows, mathematical symbols, currency signs, and miscellaneous icons**. Perfect for chat apps, games, educational tools, financial apps, or any Python project requiring Unicode characters.

Version 2.x introduces a clean, discoverable API while maintaining backward compatibility
with version 1.x.

## Installation

Install from PyPI:

```bash
pip install symjoy
```

## Usage

#### 1. Quick Start (v2 API)

```python
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
```

#### 2. Category APIs

Each category exposes the same interface:

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

##### **Example**

```python
from symjoy import emoji

emoji.list()
emoji.items()
```

#### 3. Global Search

Search across all categories:

```python
from symjoy import search

results = search("heart")
```

Expected results:

```
[
  {
    "name": "heart",
    "char": "♥",
    "category": "symbols",
    "unicode": "U+2665"
  }
]
```

#### 4. Backward Compatibility (v1.x)

Version 2.x still supports v1-style access:

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

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

### 5. Helper APIs (v2.1+)

Each category now supports metadata helpers:

```python
from symjoy import emoji

emoji.exists("smile")   # True / False

emoji.info("smile")
# {
#   "name": "smile",
#   "char": "😄",
#   "category": "emoji",
#   "unicode": "U+1F604"
# }
```

These helpers are available for:
`emoji`, `math`, `arrows`, `currency`, `misc`, and `symbols`.

### 6. Github Link

**If any issue with the package you can contact here:**

-   **Email:** vishwanathdvgmm@gmail.com

**The source code is available on GitHub**

-   **Github:** https://github.com/vishwanathdvgmm/symjoy
