Skip to main content

Emoji searcher for use with fzf

Project description

Code style: black GitHub Workflow Status PyPI version PyPI pyversions License: MIT

emoji fzf

Small utility for manipulating emojis via fzf's --preview hook!

Depends on fzf being installed to the system (integrates via bash alias/ function rather than using fzf bindings or whatnot).

Use it

To use with fzf's preview browser, you'll need to install fzf, see instructions: https://github.com/junegunn/fzf#installation

pip install emoji-fzf

# if you aren't installing to a virtual env, you may need to add this to path
# (if it wasn't already) to access the tool
export PATH=$PATH:~/.local/bin

# add me to your ~/.bashrc or ~/.zshrc or whatnot
alias emoj="emoji-fzf preview | fzf --preview 'emoji-fzf get --name {1}' | cut -d \" \" -f 1 | emoji-fzf get"
# to copy to xclip system keyboard (on mac use pbcopy) after selecting
emoj | xclip -selection c

Alternative setup

If you prefer not to use fzf's preview feature and have the emojis appear before their aliases you can use the following alias instead:

alias emoj="emoji-fzf preview --prepend | fzf | awk '{ print \$1 }'"

Development/testing

This uses a Dockerfile to keep the test build environment relatively clean and locked. The full test infrastructure is:

  • Docker container, based on buildpack Debian jessie image
  • tox-conda, which enables us to install any python version available on conda channels (here just a few since the supported list is relatively small)
  • tox to run the tests + build checks
  • black formatting check
  • check-wheel-contents and isort for more styling/idiomatic usage checks

To run the test suite in docker just as CI does:

# build the image and tag it as 'emoji-fzf'
docker build -t emoji-fzf --build-arg "UID=$(id -u)" -f Dockerfile

# from this repo root, mount the cwd into the container and run tox
docker run -v $(pwd):/mnt/workspace -t emoji-fzf bash -c "cd /mnt/workspace && tox"

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

emoji_fzf-0.3.0-py2.py3-none-any.whl (49.8 kB view hashes)

Uploaded Python 2 Python 3

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