pilmoji-for-parser 0.1.6

Pilmoji for nonebot-plugin-parser

Pilmoji for Parser

A simplified emoji renderer for Pillow, Python's imaging library. This is a streamlined fork optimized for use with nonebot-plugin-parser.

✨ Features

• 🎨 Unicode Emoji Support - Render standard Unicode emojis
• 💬 Discord Emoji Support - Render custom Discord emojis
• 📝 Multi-line Text - Automatic line break handling
• 🎭 Multiple Emoji Styles - Apple, Google, Twitter, Facebook
• ⚡ Async/Await - Built with modern async Python
• 💾 Smart Caching - Local file caching for better performance
• 🔧 Simple API - Easy-to-use interface with sensible defaults

📦 Installation

Requirements: Python 3.10 or higher

pip install pilmoji-for-parser

Or install from source:

git clone https://github.com/fllesser/pilmoji-for-parser.git
cd pilmoji-for-parser
pip install .

🚀 Quick Start

Basic Usage (Unicode Emoji Only)

import asyncio
from pilmoji import Pilmoji
from PIL import Image, ImageFont

async def main():
    text = '''
    Hello, world! 👋 
    Here are some emojis: 🎨 🌊 😎
    Multi-line support! 🚀 ✨
    '''
    
    # Create image
    image = Image.new('RGB', (550, 150), (255, 255, 255))
    font = ImageFont.truetype('arial.ttf', 24)
    
    # Render text with emojis
    async with Pilmoji() as pilmoji:
        await pilmoji.text(image, (10, 10), text.strip(), font, fill=(0, 0, 0))
    
    image.save('output.png')
    image.show()

asyncio.run(main())

With Discord Emoji Support

async def main():
    text = '''
    Unicode emoji: 👋 🎨 😎
    Discord emoji: <:custom:123456789012345678>
    '''
    
    image = Image.new('RGB', (550, 100), (255, 255, 255))
    font = ImageFont.truetype('arial.ttf', 24)
    
    async with Pilmoji() as pilmoji:
        await pilmoji.text_with_discord_emoji(
            image, (10, 10), text.strip(), font, fill=(0, 0, 0)
        )
    
    image.save('output.png')

asyncio.run(main())

🎨 Emoji Styles

Choose from different emoji styles:

from pilmoji import Pilmoji, EmojiStyle, EmojiCDNSource

# Apple style (default)
source = EmojiCDNSource(style=EmojiStyle.APPLE)

# Google style
source = EmojiCDNSource(style=EmojiStyle.GOOGLE)

# Twitter style
source = EmojiCDNSource(style=EmojiStyle.TWITTER)

# Facebook style
source = EmojiCDNSource(style=EmojiStyle.FACEBOOK)

async with Pilmoji(source=source) as pilmoji:
    await pilmoji.text(image, (10, 10), "Hello 👋", font)

🔧 API Reference

Pilmoji

Main class for rendering text with emojis.

Constructor:

Pilmoji(
    source: BaseSource = EmojiCDNSource(),
    cache: bool = True
)

Parameters:

• source: Emoji source to use (default: EmojiCDNSource())
• cache: Enable emoji caching (default: True)

Methods:

async text(image, xy, text, font, fill=None)

Render text with Unicode emoji support.

• image: PIL Image object to render onto
• xy: Tuple of (x, y) coordinates for text position
• text: Text string to render (supports multiple lines)
• font: PIL Font object
• fill: Text color (default: black)

async text_with_discord_emoji(image, xy, text, font, fill=None)

Render text with both Unicode and Discord emoji support.

Parameters are the same as text().

EmojiCDNSource

Default emoji source using emojicdn.elk.sh.

Constructor:

EmojiCDNSource(
    style: EmojiStyle = EmojiStyle.APPLE,
    cache_dir: Path | None = None
)

Parameters:

• style: Emoji style to use (Apple, Google, Twitter, Facebook)
• cache_dir: Custom cache directory (default: ~/.cache/pilmoji)

🔌 Custom Emoji Sources

Create your own emoji source by subclassing BaseSource:

from pilmoji import BaseSource
from io import BytesIO

class CustomEmojiSource(BaseSource):
    async def get_emoji(self, emoji: str) -> BytesIO | None:
        # Your custom emoji fetching logic
        pass
    
    async def get_discord_emoji(self, id: int) -> BytesIO | None:
        # Your custom Discord emoji fetching logic
        pass

# Use your custom source
async with Pilmoji(source=CustomEmojiSource()) as pilmoji:
    await pilmoji.text(image, (10, 10), "Hello 👋", font)

📝 Examples

Different Text Colors

# Red text
await pilmoji.text(image, (10, 10), "Red text 🔴", font, fill=(255, 0, 0))

# RGB tuple
await pilmoji.text(image, (10, 50), "Blue text 🔵", font, fill=(0, 0, 255))

# RGBA tuple with transparency
await pilmoji.text(image, (10, 90), "Semi-transparent 👻", font, fill=(0, 0, 0, 128))

Multi-line Text

text = """Line 1 with emoji 🎨
Line 2 with emoji 🌊
Line 3 with emoji 😎"""

await pilmoji.text(image, (10, 10), text, font, fill=(0, 0, 0))

Without Context Manager

pilmoji = Pilmoji()
await pilmoji.text(image, (10, 10), "Hello 👋", font)
await pilmoji.aclose()  # Don't forget to close!

🧪 Development

Setup

# Clone the repository
git clone https://github.com/fllesser/pilmoji-for-parser.git
cd pilmoji-for-parser

# Install dependencies
uv sync --dev

# Run tests
uv run pytest

# Run linting
uv run ruff check src/

Running Tests

# Run all tests
uv run poe test

# Run with coverage
uv run pytest --cov=src --cov-report=html

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Original Pilmoji project by jay3332
• Pillow - Python Imaging Library
• emojicdn.elk.sh - Emoji CDN service

🔗 Links

• Repository: https://github.com/fllesser/pilmoji-for-parser
• Issues: https://github.com/fllesser/pilmoji-for-parser/issues
• Releases: https://github.com/fllesser/pilmoji-for-parser/releases
• Related Project: nonebot-plugin-parser