README

README#

emoji-data#

CI Documentation Status PyPI

A library that represents emoji sequences and characters based on the Unicode® Technical Standard #51 Data Files.

Install#

pip install emoji-data

How to use#

See docs/notebooks/example.ipynb

Development#

Updating emoji data files#

To update the emoji data files from Unicode:

python scripts/download.py

This script uses httpx with concurrent downloads and displays progress bars. Files are saved to src/emoji_data/data/.

How to Build the Documentation#

  1. The documentation is built using Sphinx.

    We need to install the package itself in editable mode, Sphinx, and some of its extensions used in the documentation:

    • Using pip:

      pip install -e . --group docs

    • Using uv:

      uv sync --group docs

  2. Generate API documentation.

    If it’s the first time building the documentation, or if the source tree has changed, you may need a clean docs/api directory and regenerate the API documentation:

    sphinx-apidoc -H "" -feo docs/api src

  3. Build HTML documentation:

    • Using the Make tool (on Unix-like systems):

      make -C docs html

    • On Windows:

      docs\make html

The built static website is located at docs/_build/html. You can serve it with a simple HTTP server:

python -m http.server -d docs/_build/html

Then open http://localhost:8000/ in a web browser.

Tip

Try another port if 8000 is already in use. For example, to serve on port 8080:

python -m http.server -d docs/_build/html 8080

See also

Python stdlib’s http.server