em-keyboard


Nameem-keyboard JSON
Version 4.5.0 PyPI version JSON
download
home_pageNone
SummaryThe CLI Emoji Keyboard
upload_time2024-12-13 13:42:37
maintainerHugo van Kemenade
docs_urlNone
authorNone
requires_python>=3.9
licenseISC
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

[![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)
[![GitHub](https://img.shields.io/github/license/hugovk/em-keyboard.svg)](LICENSE)

**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
```

That's it!

## 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/27/4e/a8a94fda2ff9266b66c4294ee6ab7682ee2186e04aeee4703af26e58554e/em_keyboard-4.5.0.tar.gz",
    "platform": null,
    "description": "# em: the cli emoji keyboard\n\n[![PyPI version](https://img.shields.io/pypi/v/em-keyboard.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/em-keyboard/)\n[![Supported Python versions](https://img.shields.io/pypi/pyversions/em-keyboard.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/em-keyboard/)\n[![PyPI downloads](https://img.shields.io/pypi/dm/em-keyboard.svg)](https://pypistats.org/packages/em-keyboard)\n[![GitHub Actions status](https://github.com/hugovk/em-keyboard/workflows/Test/badge.svg)](https://github.com/hugovk/em-keyboard/actions)\n[![codecov](https://codecov.io/gh/hugovk/em-keyboard/branch/main/graph/badge.svg)](https://codecov.io/gh/hugovk/em-keyboard)\n[![GitHub](https://img.shields.io/github/license/hugovk/em-keyboard.svg)](LICENSE)\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\nThat's it!\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": "ISC",
    "summary": "The CLI Emoji Keyboard",
    "version": "4.5.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": "",
            "digests": {
                "blake2b_256": "1d05be614450d167154c73611f5544185792d0ed714478492d4badbf50e8a25e",
                "md5": "b91a280c73f40be94f69b1d397d88eff",
                "sha256": "abfedc99a7a23baa6e322c8a6078a80cf3eee0af638a00a12cbcd8b27fd279a4"
            },
            "downloads": -1,
            "filename": "em_keyboard-4.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b91a280c73f40be94f69b1d397d88eff",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 106856,
            "upload_time": "2024-12-13T13:42:35",
            "upload_time_iso_8601": "2024-12-13T13:42:35.807879Z",
            "url": "https://files.pythonhosted.org/packages/1d/05/be614450d167154c73611f5544185792d0ed714478492d4badbf50e8a25e/em_keyboard-4.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "274ea8a94fda2ff9266b66c4294ee6ab7682ee2186e04aeee4703af26e58554e",
                "md5": "f76b09e32752cc279f4b7fa8beb909d0",
                "sha256": "b6cbe50b3dc07f1c6d2a68e8d3bd34a4f6a3e21dfd5df939f59410db0510200c"
            },
            "downloads": -1,
            "filename": "em_keyboard-4.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f76b09e32752cc279f4b7fa8beb909d0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 111033,
            "upload_time": "2024-12-13T13:42:37",
            "upload_time_iso_8601": "2024-12-13T13:42:37.817717Z",
            "url": "https://files.pythonhosted.org/packages/27/4e/a8a94fda2ff9266b66c4294ee6ab7682ee2186e04aeee4703af26e58554e/em_keyboard-4.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-13 13:42:37",
    "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"
}
        
Elapsed time: 0.41010s