dismoji 0.1.0__tar.gz

dismoji-0.1.0/.gitignore

@@ -0,0 +1,175 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+./build/ # so hatch includes discord-emojis' build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# PyPI configuration file
+.pypirc
+
+_version.py
+
+node_modules/

dismoji-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Paillat-dev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dismoji-0.1.0/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: dismoji
+Version: 0.1.0
+Summary: ***
+Project-URL: Homepage, https://github.com/Paillat-dev/dismoji
+Project-URL: source_archive, https://github.com/Paillat-dev/dismoji/archive/ab6b493057d327dc84552c32c00d1c80aa2ed92f.zip
+Author-email: Paillat-dev <me@paillat.dev>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: bot,discord,emoji,emojis
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: ==3.12.*
+Requires-Dist: json5>=0.12.0
+Description-Content-Type: text/markdown
+
+
+![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. 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](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! 🥳"
+```
+
+## 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](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
+
+## License
+
+MIT License - Copyright (c) 2025 Paillat-dev
+
+---
+
+Made with ❤ by Paillat-dev

dismoji-0.1.0/pyproject.toml

@@ -0,0 +1,158 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs", "hatch-fancy-pypi-readme"]
+build-backend = "hatchling.build"
+
+[project]
+name = "dismoji"
+dynamic = ["version", "urls", "readme"]
+description = "***"
+authors = [
+    { name = "Paillat-dev", email = "me@paillat.dev" }
+]
+license = "MIT"
+requires-python = "==3.12.*"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.9",
+    "Typing :: Typed",
+    "Operating System :: OS Independent",
+]
+keywords = ["discord", "bot", "emojis", "emoji"]
+dependencies = [
+    "json5>=0.12.0",
+]
+
+[dependency-groups]
+dev = [
+    "basedpyright>=1.28.1",
+    "pytest>=8.3.5",
+    "python-dotenv>=1.0.1",
+    "ruff>=0.9.9",
+]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/dismoji/_version.py"
+
+[tool.hatch.metadata.hooks.vcs.urls]
+Homepage = "https://github.com/Paillat-dev/dismoji"
+source_archive = "https://github.com/Paillat-dev/dismoji/archive/{commit_hash}.zip"
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/markdown"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
+path = "README.md"
+start-after = "<!-- badges -->\n"
+end-before = "\n<!-- end badges -->"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
+text = "\n\n---\n"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
+path = "README.md"
+start-after = "## Overview\n"
+end-before = "\n## Installation"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
+path = "README.md"
+start-after = "<!-- quick-start -->"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
+replacement = '[\1](https://github.com/Paillat-dev/dismoji/tree/main\g<2>)'
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = '\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)\]'
+replacement = '**\1**:'
+
+[tool.hatchling]
+name = "dismoji"
+
+[tool.hatch.build]
+include = [
+    "src/dismoji/",
+    "src/dismoji/raw/build/emojis.json",
+]
+exclude = [
+    ".copywrite.hcl",
+    ".github",
+    ".python-version",
+    "uv.lock",
+    "src/dismoji/raw/*.*",
+    "src/dismoji/raw/.*/",
+    "src/dismoji/raw/src/"
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/dismoji"]
+
+[tool.pyright]
+pythonVersion = "3.9"
+typeCheckingMode = "all"
+reportUnusedCallResult = false
+reportAny = false
+executionEnvironments = [
+    { root = "src/dismoji/_version.py", reportDeprecated = false },
+    { root = "examples", reportExplicitAny = false, reportUnknownMemberType = false, reportUnusedParameter = false, reportImplicitOverride = false }
+]
+
+[tool.ruff]
+target-version = "py39"
+line-length = 120
+indent-width = 4
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+docstring-code-format = false
+docstring-code-line-length = "dynamic"
+exclude = [
+    "src/dismoji/_version.py"
+]
+
+[tool.ruff.lint]
+select = ["ALL"]
+per-file-ignores = { "examples/**/*" = ["INP001", "ARG002", "T201"], "tests/**/*" = ["S101"], "src/dismoji/_version.py" = ["I001", "Q000", "UP005", "UP006", "UP035"] }
+extend-ignore = [
+    "N999",
+    "D104",
+    "D100",
+    "D103",
+    "D102",
+    "D101",
+    "D107",
+    "D105",
+    "D106",
+    "ANN401",
+    "TRY003",
+    "EM101",
+    "EM102",
+    "G004",
+    "PTH",
+    "D211",
+    "D213",
+    "COM812",
+    "ISC001",
+    "D203",
+    "FBT001",
+    "FBT002",
+    "PLR2004",
+    "PLR0913",
+    "C901",
+    "ISC003" # conflicts with basedpyright reportImplicitStringConcatenation
+]
+
+[tool.uv.sources]
+py-cord = { git = "https://github.com/Pycord-Development/pycord", rev = "c0c0b7c58f7b489983a159f5e0eea2c0dab0b0c8" }

dismoji-0.1.0/src/dismoji/__init__.py

@@ -0,0 +1,37 @@
+# Copyright (c) Paillat-dev
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+
+import json
+import re
+from pathlib import Path
+
+EMOJIS_PATH = Path(__file__).parent / "raw" / "build" / "emojis.json"
+
+with EMOJIS_PATH.open("r", encoding="utf-8") as f:
+    EMOJIS = json.load(f)
+
+EMOJI_MAPPING: dict[str, str] = {k: EMOJIS["emojis"][v]["surrogates"] for k, v in EMOJIS["nameToEmoji"].items()}
+
+EMOJI_PATTERN = re.compile(r"(?<!\w):([a-zA-Z0-9_-]+):(?!\w)")
+
+
+def emojize(s: str) -> str:
+    """Convert a string with emoji names to a string with emoji characters.
+
+    Args:
+        s (str): The input string containing emoji names.
+
+    Returns:
+        str: The input string with emoji names replaced by emoji characters.
+
+    """
+
+    def replace(match: re.Match[str]) -> str:
+        emoji_name = match.group(1)
+        if emoji_name in EMOJI_MAPPING:
+            return EMOJI_MAPPING[emoji_name]
+        return match.group(0)
+
+    return EMOJI_PATTERN.sub(replace, s)

dismoji-0.1.0/src/dismoji/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)