| Name | em-keyboard JSON |
| Version |
5.0.0
JSON |
| download |
| home_page | None |
| Summary | The CLI Emoji Keyboard |
| upload_time | 2025-01-29 15:36:44 |
| maintainer | Hugo van Kemenade |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
cli
emoji
keyboard
search
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# em: the cli emoji keyboard
[](https://pypi.org/project/em-keyboard/)
[](https://pypi.org/project/em-keyboard/)
[](https://pypistats.org/packages/em-keyboard)
[](https://github.com/hugovk/em-keyboard/actions)
[](https://codecov.io/gh/hugovk/em-keyboard)
[](LICENSE)
[](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:
<!-- [[[cog
from scripts.run_command import run
run("em sparkles shortcake sparkles")
]]] -->
```console
$ em sparkles shortcake sparkles
Copied! ✨ 🍰 ✨
```
<!-- [[[end]]] -->
Let's skip the copying (for scripts):
<!-- [[[cog run("em 'chocolate bar' --no-copy") ]]] -->
```console
$ em 'chocolate bar' --no-copy
🍫
```
<!-- [[[end]]] -->
Let's find some emoji, by color:
<!-- [[[cog run("em -s yellow") ]]] -->
```console
$ em -s yellow
💛 yellow_heart
🌼 blossom
🌕 full_moon
⭐ star
🚸 children_crossing
🟡 yellow_circle
🟨 yellow_square
```
<!-- [[[end]]] -->
If there's only a single search result, it's copied:
<!-- [[[cog run("em -s ukraine") ]]] -->
```console
$ em -s ukraine
Copied! 🇺🇦 flag_ukraine
```
<!-- [[[end]]] -->
## 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!
✨🍰✨
Raw data
{
"_id": null,
"home_page": null,
"name": "em-keyboard",
"maintainer": "Hugo van Kemenade",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "CLI, emoji, keyboard, search",
"author": null,
"author_email": "Kenneth Reitz <me@kennethreitz.org>",
"download_url": "https://files.pythonhosted.org/packages/ea/d9/459aa47ed0dfa9301af0cf468b5d65f528142a144baf9339d5d33b31db97/em_keyboard-5.0.0.tar.gz",
"platform": null,
"description": "# em: the cli emoji keyboard\n\n[](https://pypi.org/project/em-keyboard/)\n[](https://pypi.org/project/em-keyboard/)\n[](https://pypistats.org/packages/em-keyboard)\n[](https://github.com/hugovk/em-keyboard/actions)\n[](https://codecov.io/gh/hugovk/em-keyboard)\n[](LICENSE)\n[](https://github.com/psf/black)\n\n**Emoji your friends and colleagues from the comfort of your own terminal.**\n\n**em** is a nifty command-line utility for referencing emoji characters by name. Provide\nthe names of a few emoji, and those lucky chosen emojis will be displayed in your\nterminal, then copied to your clipboard. Automagically.\n\nEmoji can be also searched by both categories and aspects.\n\n## Example Usage\n\nLet's serve some delicious cake:\n\n<!-- [[[cog\nfrom scripts.run_command import run\nrun(\"em sparkles shortcake sparkles\")\n]]] -->\n\n```console\n$ em sparkles shortcake sparkles\nCopied! \u2728 \ud83c\udf70 \u2728\n```\n\n<!-- [[[end]]] -->\n\nLet's skip the copying (for scripts):\n\n<!-- [[[cog run(\"em 'chocolate bar' --no-copy\") ]]] -->\n\n```console\n$ em 'chocolate bar' --no-copy\n\ud83c\udf6b\n```\n\n<!-- [[[end]]] -->\n\nLet's find some emoji, by color:\n\n<!-- [[[cog run(\"em -s yellow\") ]]] -->\n\n```console\n$ em -s yellow\n\ud83d\udc9b yellow_heart\n\ud83c\udf3c blossom\n\ud83c\udf15 full_moon\n\u2b50 star\n\ud83d\udeb8 children_crossing\n\ud83d\udfe1 yellow_circle\n\ud83d\udfe8 yellow_square\n```\n\n<!-- [[[end]]] -->\n\nIf there's only a single search result, it's copied:\n\n<!-- [[[cog run(\"em -s ukraine\") ]]] -->\n\n```console\n$ em -s ukraine\nCopied! \ud83c\uddfa\ud83c\udde6 flag_ukraine\n```\n\n<!-- [[[end]]] -->\n\n## Installation\n\nAt this time, **em** requires Python and pip:\n\n```sh\npython3 -m pip install em-keyboard\n```\n\nOn Linux, an additional dependency is required for automatic copying to clipboard. This\nwould be either [`xclip`](https://github.com/astrand/xclip) in an X11 session or\n[`wl-clipboard`](https://github.com/bugaevc/wl-clipboard) in a Wayland session. On a\nDebian-based distribution these are installable with:\n\n```sh\nsudo apt install xclip\nsudo apt install wl-clipboard\n```\n\n## Tests\n\nIf you wanna develop, you might want to write and run tests:\n\n```sh\npython3 -m pip install tox\ntox\n```\n\n## Have fun!\n\n\u2728\ud83c\udf70\u2728\n",
"bugtrack_url": null,
"license": null,
"summary": "The CLI Emoji Keyboard",
"version": "5.0.0",
"project_urls": {
"Changelog": "https://github.com/hugovk/em-keyboard/releases",
"Homepage": "https://github.com/hugovk/em-keyboard",
"Source": "https://github.com/hugovk/em-keyboard"
},
"split_keywords": [
"cli",
" emoji",
" keyboard",
" search"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4253f558e9eb34b8187ab3661ab4718cf89ff46f96ba309cc6b362db672329f4",
"md5": "b3bfb0afed02f4628919adda616f704a",
"sha256": "529b99603c5789aafc4a5fbcc9c66389d7b8a99f8cb670ec838b7225bc849ed2"
},
"downloads": -1,
"filename": "em_keyboard-5.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3bfb0afed02f4628919adda616f704a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 54898,
"upload_time": "2025-01-29T15:36:42",
"upload_time_iso_8601": "2025-01-29T15:36:42.379190Z",
"url": "https://files.pythonhosted.org/packages/42/53/f558e9eb34b8187ab3661ab4718cf89ff46f96ba309cc6b362db672329f4/em_keyboard-5.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ead9459aa47ed0dfa9301af0cf468b5d65f528142a144baf9339d5d33b31db97",
"md5": "3b26c00acc7376417c5fc32e8e7d481f",
"sha256": "987554d304871c048aac8c1e85df3d8a381429f3444ce7f0512c5a6e06b00055"
},
"downloads": -1,
"filename": "em_keyboard-5.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3b26c00acc7376417c5fc32e8e7d481f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 60337,
"upload_time": "2025-01-29T15:36:44",
"upload_time_iso_8601": "2025-01-29T15:36:44.407666Z",
"url": "https://files.pythonhosted.org/packages/ea/d9/459aa47ed0dfa9301af0cf468b5d65f528142a144baf9339d5d33b31db97/em_keyboard-5.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-29 15:36:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hugovk",
"github_project": "em-keyboard",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "em-keyboard"
}
