README

emoji-data

CI Documentation Status PyPI

A library represents emoji sequences and characters in Unicode® Technical Standard #51 Data Files

Install

pip install emoji-data

How to use

See notebooks/example.ipynb

How to build docs

  1. This documentation is made with Sphinx, be sure to install it’s dependencies:

    pip install -r docs/requirements.txt
    

    Ignore this step if requirements already installed.

  2. (Optional) Re-generate API-Docs, if source tree changed:

    sphinx-apidoc -o docs/apidocs -eMTf src
    
  3. Build HTML documentation:

    docs/make html
    

The built static web site is output to docs/_build/html, we can serve it:

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