mirror of
https://github.com/Paillat-dev/dismoji.git
synced 2026-01-02 00:56:19 +00:00
a714f4d53c38e28d547f8c408e9941b7270ac536
Table of Contents
- Overview
- Installation
- Quick Start
- Features
- Limitations
- Getting Help
- Development
- Contributing
- License
Overview
dismoji is a lightweight Python library that provides a simple way to convert Discord
emoji names to their Unicode equivalents. With just a single function call, you can
transform text containing Discord-style emoji codes (like :smile:) into text with
actual Unicode emoji characters (like "😄").
This library uses Paillat-dev/discord-emojis as the source for Discord emoji names and aliases.
Installation
pip install dismoji
Quick Start
import dismoji
# Convert Discord emoji names to Unicode emojis
text = "Hello, :wave: I'm excited! :partying_face:"
converted_text = dismoji.emojize(text)
print(converted_text) # Output: "Hello, 👋 I'm excited! 🥳"
Features
- Simple API: Just one function to remember -
dismoji.emojize() - Discord Compatible: Supports Discord's emoji naming conventions
- Comprehensive: Includes all standard emojis available on Discord
- Type Safe: Fully type-annotated for better IDE integration
- Zero Dependencies: Lightweight with no external dependencies
- Fast: Optimized for quick emoji replacement
Getting Help
If you encounter issues or have questions about dismoji:
- GitHub Issues: Submit a bug report or feature request
- Discord Support: Join the Pycord Official Server and
mention
@paillat
Development
Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Run linter, formatter and type checker:
ruff check .,ruff format .,basedpyright . - Submit a pull request
Development Tools:
- uv: For dependency management
- Ruff: For linting and formatting
- HashiCorp Copywrite: For managing license headers
- basedpyright: For type checking
License
MIT License - Copyright (c) 2025 Paillat-dev
Made with ❤ by Paillat-dev
Description
Languages
Python
100%