Skip to main content

Module providing Emoji encoding for Python

Project description

# Emoji encoding for 🐍

This module provides a custom source code encoding allowing usage of Emoji's for things like variable names or function names.

## Usage

Install the package with pip:
pip install emoji-encoding
**It's recommended to install it in [a virtualenv](**

After installation you can specify the encoding in the beginning of a Python file:

# -*- coding: emoji -*-
def 📢(✉️):

📢("✋ 🌏")

## Uninstalling

This package will create `emoji.pth` file in your `site-packages` directory to autoload the codec. After removing the module you need to remove this file manually.

## Known issues

Currently the encoding is only available in imported modules so trying to run Emoji encoded file directly will fail:

$ python
File "", line 1
SyntaxError: encoding problem: emoji

Easy workaround is to have an another file that imports the Emoji encoded file:

$ cat
import emoji
$ python
✋ 🌏

## History

It all started with Ola Sendecka's talk about [Emoji Driven Development]( which made me wonder: "why *can't* we use Emoji's in Python?". After a bit of hacking I was able to use them [with a patched cpython]( This wasn't a perfect solution so playing with this idea I ended up with custom [codec]( that translates Emoji's to their ASCII representations and adds prefix/suffix to decode such unique string back to Unicode.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

emoji-encoding-0.0.5.tar.gz (4.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page