curses-fzf 0.3.0

A pure python implementation of fzf (fuzzyfinder) with some additional features using the curses library.

curses-fzf

About

A pure Python implementation of fzf (fuzzyfinder) using the curses library - no external fzf binary required.

Although there are many good fzf libraries available, they all have one thing in common: They are wrappers to the shell tool fzf.

This is not inherently bad, but has one major downside: It does not integrate well into Python code.

• What if you want to fuzzy-find over a list of dicts or objects?
• What if you want to pre-select items (e.g. tags already set for a resource, that could be unset while selecting new ones)?
• What if you want to display additional information along with the entry to fuzzy-find on?
• What if you want to customize the fuzzy-finder algorithm?

To all of the above questions this module is the answer.

What can it do?

It provides a curses-based TUI for fuzzy-searching lists of any item type. Perfect for CLI tools needing interactive filtering of user options.

It allows for single or multi select, preview functions, preselection of items and more. The module is designed to be highly customizable to fit your use-case: Provide your own scoring logic, remap keys or add your own functions to keybindings, change the color theme, ...

It is easy and straight-forward to use:

from curses_fzf import FuzzyFinder, CursesFzfAborted

data = ["apple", "banana", "grape", "orange", "watermelon"]
fzf = FuzzyFinder(multi=True)
try:
    result = fzf.find(data)
except CursesFzfAborted:
    print("Fuzzy finder aborted by user.")
else:
    for item in result:
        print(item)

See documentation - basic usage for further details.