dismoji


Namedismoji JSON
Version 0.3.0 PyPI version JSON
download
home_pageNone
SummaryA Python library for converting Discord emoji names to their Unicode equivalents.
upload_time2025-10-08 13:24:03
maintainerNone
docs_urlNone
authorNone
requires_python<3.15,>=3.10
licenseNone
keywords bot discord emoji emojis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
![PyPI - Version](https://img.shields.io/pypi/v/dismoji)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dismoji)
![PyPI - Types](https://img.shields.io/pypi/types/dismoji)
![PyPI - License](https://img.shields.io/pypi/l/dismoji)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Paillat-dev/dismoji/CI.yaml)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Paillat-dev/dismoji/main.svg)](https://results.pre-commit.ci/latest/github/Paillat-dev/dismoji/main)


---

Dismoji is a lightweight Python library that provides a simple way to convert Discord
emoji names to their Unicode equivalents and vice versa. With just two function calls,
you can transform text containing Discord-style emoji codes (like `:smile:`) into text
with actual Unicode emoji characters (like "😄") and back again.

This library uses
[Paillat-dev/discord-emojis](https://github.com/Paillat-dev/discord-emojis) as the
source for Discord emoji names and aliases.


```python
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! 🥳"

# Convert Unicode emojis back to Discord emoji names
emoji_text = "Hello, 👋 I'm excited! 🥳"
named_text = dismoji.demojize(emoji_text)
print(named_text)  # Output: "Hello, :wave: I'm excited! :partying_face:"
```

## Features

- **Simple API**: Just two functions to remember - `dismoji.emojize()` and
  `dismoji.demojize()`
- **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
- **Bidirectional**: Convert between emoji names and characters in both directions

## Getting Help

If you encounter issues or have questions about dismoji:

- **GitHub Issues**:
  [Submit a bug report or feature request](https://github.com/Paillat-dev/dismoji/issues)
- **Discord Support**: Join the [Pycord Official Server](https://discord.gg/pycord) and
  mention `@paillat`

## Development

### Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run linter, formatter and type checker: `ruff check .`, `ruff format .`,
   `basedpyright .`
5. 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

## Acknowledgements

- [`emoji`](https://pypi.org/project/emoji/) as inspiration for the API design

## License

MIT License - Copyright (c) 2025 Paillat-dev

---

Made with ❤ by Paillat-dev

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "dismoji",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.15,>=3.10",
    "maintainer_email": null,
    "keywords": "bot, discord, emoji, emojis",
    "author": null,
    "author_email": "Paillat-dev <me@paillat.dev>",
    "download_url": "https://files.pythonhosted.org/packages/4e/c2/039749aad99bc4851a7cb6c02e554db8a7f79df05f83da49e0e0002fc916/dismoji-0.3.0.tar.gz",
    "platform": null,
    "description": "\n![PyPI - Version](https://img.shields.io/pypi/v/dismoji)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dismoji)\n![PyPI - Types](https://img.shields.io/pypi/types/dismoji)\n![PyPI - License](https://img.shields.io/pypi/l/dismoji)\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Paillat-dev/dismoji/CI.yaml)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Paillat-dev/dismoji/main.svg)](https://results.pre-commit.ci/latest/github/Paillat-dev/dismoji/main)\n\n\n---\n\nDismoji is a lightweight Python library that provides a simple way to convert Discord\nemoji names to their Unicode equivalents and vice versa. With just two function calls,\nyou can transform text containing Discord-style emoji codes (like `:smile:`) into text\nwith actual Unicode emoji characters (like \"\ud83d\ude04\") and back again.\n\nThis library uses\n[Paillat-dev/discord-emojis](https://github.com/Paillat-dev/discord-emojis) as the\nsource for Discord emoji names and aliases.\n\n\n```python\nimport dismoji\n\n# Convert Discord emoji names to Unicode emojis\ntext = \"Hello, :wave: I'm excited! :partying_face:\"\nconverted_text = dismoji.emojize(text)\nprint(converted_text)  # Output: \"Hello, \ud83d\udc4b I'm excited! \ud83e\udd73\"\n\n# Convert Unicode emojis back to Discord emoji names\nemoji_text = \"Hello, \ud83d\udc4b I'm excited! \ud83e\udd73\"\nnamed_text = dismoji.demojize(emoji_text)\nprint(named_text)  # Output: \"Hello, :wave: I'm excited! :partying_face:\"\n```\n\n## Features\n\n- **Simple API**: Just two functions to remember - `dismoji.emojize()` and\n  `dismoji.demojize()`\n- **Discord Compatible**: Supports Discord's emoji naming conventions\n- **Comprehensive**: Includes all standard emojis available on Discord\n- **Type Safe**: Fully type-annotated for better IDE integration\n- **Zero Dependencies**: Lightweight with no external dependencies\n- **Fast**: Optimized for quick emoji replacement\n- **Bidirectional**: Convert between emoji names and characters in both directions\n\n## Getting Help\n\nIf you encounter issues or have questions about dismoji:\n\n- **GitHub Issues**:\n  [Submit a bug report or feature request](https://github.com/Paillat-dev/dismoji/issues)\n- **Discord Support**: Join the [Pycord Official Server](https://discord.gg/pycord) and\n  mention `@paillat`\n\n## Development\n\n### Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Run linter, formatter and type checker: `ruff check .`, `ruff format .`,\n   `basedpyright .`\n5. Submit a pull request\n\n**Development Tools**:\n\n- **uv**: For dependency management\n- **Ruff**: For linting and formatting\n- **HashiCorp Copywrite**: For managing license headers\n- **basedpyright**: For type checking\n\n## Acknowledgements\n\n- [`emoji`](https://pypi.org/project/emoji/) as inspiration for the API design\n\n## License\n\nMIT License - Copyright (c) 2025 Paillat-dev\n\n---\n\nMade with \u2764 by Paillat-dev\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python library for converting Discord emoji names to their Unicode equivalents.",
    "version": "0.3.0",
    "project_urls": {
        "Homepage": "https://github.com/Paillat-dev/dismoji",
        "source_archive": "https://github.com/Paillat-dev/dismoji/archive/5c1a32b69e460d782b8d3dc2072d9583e77e14bc.zip"
    },
    "split_keywords": [
        "bot",
        " discord",
        " emoji",
        " emojis"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b25c169f83df5ff186a709830f15db3ffa1016058fc6a176a49dfb82293aa0e6",
                "md5": "238868da37c60e2493bdc07e2bfda271",
                "sha256": "f12773557c3987a1c507e0366c7b7c0473a5373844d4526cf703594059a75d10"
            },
            "downloads": -1,
            "filename": "dismoji-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "238868da37c60e2493bdc07e2bfda271",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.15,>=3.10",
            "size": 132792,
            "upload_time": "2025-10-08T13:24:02",
            "upload_time_iso_8601": "2025-10-08T13:24:02.600083Z",
            "url": "https://files.pythonhosted.org/packages/b2/5c/169f83df5ff186a709830f15db3ffa1016058fc6a176a49dfb82293aa0e6/dismoji-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4ec2039749aad99bc4851a7cb6c02e554db8a7f79df05f83da49e0e0002fc916",
                "md5": "3a0ed878284ad9b5b558063f42cc236b",
                "sha256": "09061176faab7da2963a02fcc1ec00a64d7ac6a5355198108be20bb08ce5f75e"
            },
            "downloads": -1,
            "filename": "dismoji-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3a0ed878284ad9b5b558063f42cc236b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.15,>=3.10",
            "size": 128058,
            "upload_time": "2025-10-08T13:24:03",
            "upload_time_iso_8601": "2025-10-08T13:24:03.880615Z",
            "url": "https://files.pythonhosted.org/packages/4e/c2/039749aad99bc4851a7cb6c02e554db8a7f79df05f83da49e0e0002fc916/dismoji-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-08 13:24:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Paillat-dev",
    "github_project": "dismoji",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "dismoji"
}
        
Elapsed time: 2.10346s