Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexandrevicenzi/emojis

Emojis for Python :snake:
https://github.com/alexandrevicenzi/emojis

emoji emojify emojis python python3

Last synced: 12 days ago
JSON representation

Emojis for Python :snake:

Awesome Lists containing this project

README

        

# Emojis

[![Documentation Status](https://readthedocs.org/projects/emojis/badge/?version=latest)](https://emojis.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://github.com/alexandrevicenzi/emojis/actions/workflows/test.yml/badge.svg)](https://github.com/alexandrevicenzi/emojis/actions/workflows/test.yml)
[![PyPI](https://img.shields.io/pypi/v/emojis.svg)](https://pypi.org/project/emojis/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/emojis.svg)](https://pypi.org/project/emojis/)

Emojis for Python

## About

This library allows you to emojify content such as: `This is a message with emojis :smile: :snake:`

Emoji database is based on [gemoji](https://github.com/github/gemoji) library.

## Example

```python
>>> import emojis

>>> emojis.encode('This is a message with emojis :smile: :snake:')
'This is a message with emojis 😄 🐍'

>>> emojis.decode('This is a message with emojis 😄 🐍')
'This is a message with emojis :smile: :snake:'

>>> emojis.get('Prefix 😄 🐍 😄 🐍 Sufix')
{'😄', '🐍'}

>>> emojis.count('😄 🐍 😄 🐍')
4

>>> emojis.count('😄 🐍 😄 🐍', unique=True)
2

>>> emojis.db.get_emoji_by_alias('snake')
Emoji(aliases=['snake'], emoji='🐍', tags=[], category='Animals & Nature', unicode_version='6.0')

>>> emojis.db.get_categories()
{'Activities', 'Travel & Places', 'Smileys & Emotion', 'Symbols', 'Food & Drink', 'Animals & Nature', 'People & Body', 'Objects', 'Flags'}
```

## Installation

Install `emojis` with `pip`.

`pip3 install -U emojis`

## Documentation

[https://emojis.readthedocs.io/](https://emojis.readthedocs.io/en/latest/)

## Missing or wrong emoji?

This library is based on [gemoji](https://github.com/github/gemoji) database, the official GitHub emoji library for Ruby.

If an emoji is missing or labeled wrongly, report to [gemoji](https://github.com/github/gemoji) project.
If gemoji fix it, this library will be updated as soon as there's a new gemoji release.

All issues complaining about missing emojis will be closed.

All PRs to include custom emojis will be closed.

## License

MIT