Skip to content

Repository files navigation

emojilib

PyPI version Build and Publish

📚 Ultimate Emoji Generator library for Python

System requirements

  • Python 3.10 ~ 3.14
  • C++20 Compiler

Official supported platforms

We officially support building and running on these platforms below, but you can try it on other platforms.

  • macOS 26 Tahoe (arm64)
  • Ubuntu 24.04 (x86_64)

Used libraries

Getting started

$ pip install emojilib --extra-index-url https://repo.fury.io/emoji-gen/

Example

import emojilib

def main():
    data = emojilib.generate(text="ab\nc.", width=128, height=128)

    with open('emoji.png', 'wb') as f:
        f.write(data)

if __name__ == '__main__':
    main()

How to build

1. Compile libemoji

First, please build externals. See also libemoji's README.

$ git submodule update --init --recursive
$ cd externals/libemoji
$ cmake .
$ make

2. Setup Python virtualenv

$ python -m venv venv
$ . venv/bin/activate

3. Run build command

$ python setup.py build

Development

Install Dependencies

$ pip install --group dev

Test

$ pytest

Publish

Update the version in pyproject.toml to the version you want to release.

Then, manually trigger the build_and_publish.yml workflow via the workflow_dispatch event to create a release.

See also

License

MIT © Emoji Generator

About

📚 Ultimate Emoji Generator library for Python

Topics

Resources

Stars

12 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages