Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hugovk/em-keyboard

The CLI emoji keyboard
https://github.com/hugovk/em-keyboard

cli command-line-interface emoji emoji-picker hacktoberfest python terminal

Last synced: 5 days ago
JSON representation

The CLI emoji keyboard

Host: GitHub
URL: https://github.com/hugovk/em-keyboard
Owner: hugovk
License: isc
Created: 2016-03-10T05:00:13.000Z (almost 9 years ago)
Default Branch: main
Last Pushed: 2024-12-13T13:41:40.000Z (2 months ago)
Last Synced: 2024-12-15T20:02:08.411Z (2 months ago)
Topics: cli, command-line-interface, emoji, emoji-picker, hacktoberfest, python, terminal
Language: Python
Homepage:
Size: 422 KB
Stars: 311
Watchers: 7
Forks: 31
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # em: the cli emoji keyboard

[![PyPI version](https://img.shields.io/pypi/v/em-keyboard.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/em-keyboard/)

[![Supported Python versions](https://img.shields.io/pypi/pyversions/em-keyboard.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/em-keyboard/)

[![PyPI downloads](https://img.shields.io/pypi/dm/em-keyboard.svg)](https://pypistats.org/packages/em-keyboard)

[![GitHub Actions status](https://github.com/hugovk/em-keyboard/workflows/Test/badge.svg)](https://github.com/hugovk/em-keyboard/actions)

[![Codecov](https://codecov.io/gh/hugovk/em-keyboard/branch/main/graph/badge.svg)](https://codecov.io/gh/hugovk/em-keyboard)

[![Licence](https://img.shields.io/github/license/hugovk/em-keyboard.svg)](LICENSE)

[![Code style: Black](https://img.shields.io/badge/code%20style-Black-000000.svg)](https://github.com/psf/black)

**Emoji your friends and colleagues from the comfort of your own terminal.**

**em** is a nifty command-line utility for referencing emoji characters by name. Provide

the names of a few emoji, and those lucky chosen emojis will be displayed in your

terminal, then copied to your clipboard. Automagically.

Emoji can be also searched by both categories and aspects.

## Example Usage

Let's serve some delicious cake:

```console

$ em sparkles shortcake sparkles

Copied! ✨ 🍰 ✨

```

Let's skip the copying (for scripts):

```console

$ em 'chocolate bar' --no-copy

🍫

```

Let's find some emoji, by color:

```console

$ em -s yellow

💛  yellow_heart

🌼  blossom

🌕  full_moon

⭐  star

🚸  children_crossing

🟡  yellow_circle

🟨  yellow_square

```

If there's only a single search result, it's copied:

```console

$ em -s ukraine

Copied! 🇺🇦  flag_ukraine

```

## Installation

At this time, **em** requires Python and pip:

```sh

python3 -m pip install em-keyboard

```

On Linux, an additional dependency is required for automatic copying to clipboard. This

would be either [`xclip`](https://github.com/astrand/xclip) in an X11 session or

[`wl-clipboard`](https://github.com/bugaevc/wl-clipboard) in a Wayland session. On a

Debian-based distribution these are installable with:

```sh

sudo apt install xclip

sudo apt install wl-clipboard

```

## Tests

If you wanna develop, you might want to write and run tests:

```sh

python3 -m pip install tox

tox

```

## Have fun!

✨🍰✨