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

https://github.com/anthonybench/emoji

A succinct quick-access of favorite emojis & metadata.
https://github.com/anthonybench/emoji

Last synced: 2 months ago
JSON representation

A succinct quick-access of favorite emojis & metadata.

Awesome Lists containing this project

README

          

# **SleepyEmoji**
*Fetch your favorite emojis fast!*


## **Welcome to sleepyemoji!**
There's now a paralyzing volume of unicode characters known as "emojis", which is great for creative expression, but bad for fetching the ~%10 of emojis you ever care to use.

SleepyEmoji has entered the chat!


### **Table of Contents** 📖


- **Get Started**
- Usage
- Technologies
- Contribute
- Acknowledgements
- License/Stats/Author


## **Get Started 🚀**


```sh
pip install sleepyemoji
pip install --upgrade sleepyemoji
```


## **Usage ⚙**


Fetch dependencies:
```sh
pip install -r requirements.txt
```

Set a function in your shell environment to run a script like:
```sh
# pip install sleepyemoji
# pip install --upgrade sleepyemoji

from sleepyemoji import sleepyemoji
from sys import argv, exit

sleepyemoji(argv[1:])
exit(0)
```

Presuming you've named said function `emoji`, print the help message:
```sh
emoji --help
```


## **Technologies 🧰**


- [prettytable](https://pypi.org/project/prettytable/)
- [typer](https://typer.tiangolo.com/)


## **Contribute 🤝**


If you feel slighted by your favorite emojis not being list in `emoji_toolchain/emojis`, submit a PR 😊.


## **Acknowledgements 💙**


Thanks to my late cat Merlin, who whispered best practices in my ear while I wrote this.


## **License, Stats, Author 📜**


example image tag

![PyPI - License](https://img.shields.io/pypi/l/sleepyemoji?style=plastic)

See [License](LICENSE) for the full license text.

This package was authored by *Isaac Yep*.