Fzf.py - A Pythonic Fzf Wrapper

Fully covers the fzf command line arguments, alongside Pythonic generators and context managers.

This project uses subprocess.PIPE at a non-blocking interface with the fzf stdin. This allows the project to:

Write continuously to the fzf stdin,
Stop when the fzf stdin is closed,
Not write any files and use the unsafe shell interface. Ahem.

Installation

This project can be installed on to your device via different mechanisms, these mechanisms are listed below in the order of ease.

PIP Installs Packages aka PIP Installation

$ pip install git+https://www.github.com/justfoolingaround/fzf.py

Source Code Download
```
$ git clone https://www.github.com/justfoolingaround/fzf.py
```
Given that you have git installed, you can clone the repository from GitHub. If you do not have or want to deal with installation of git, you can simply download the repository using this link.

After the repository is downloaded and placed in an appropriate directory, you can use setup.py to proceed with the installation.
```
$ pip install .
```

This command is to be executed from the directory where the repository is located.

Usage

Using fzf as a questionnaire.

from fzf import fzf_prompt

output = fzf_prompt(
    [
        {
            "question": "Hey there, what's your name?",
            "answer": "It is I, of the Python world, my name is Raven.",
        },
        {
            "question": "What's your favorite color?",
            "answer": "I like blue, but I also like green.",
        },
        {
            "question": "*in shouko voice* I LOVE YOU!?",
            "answer": "I.. uh.. moon? Yeah I like the moon too.",
        }
    ],
    processor=lambda question_dict: question_dict["question"],
)

print(f"> {output['answer']}")

Using fzf as a file browser, using ls' stdout as a PIPE stream.

import subprocess

from fzf import Fzf

with Fzf.load_with_options(
    preview="cat {}"
) as fzf:
    ls = subprocess.Popen(["ls"], stdout=subprocess.PIPE)

    fzf.pipe_from_stream(ls.stdout)

print(fzf.get_output())

This is equivalent to:

ls | fzf --preview 'cat {}'

except, you can add more and more prompts.

Using fzf to check the headers of a lot of urls.

from fzf import fzf_prompt


print(
    "You picked:",
    fzf_prompt(
        [
            "https://www.github.com/justfoolingaround",
            "https://www.youtube.com/",
            "https://www.reddit.com/",
        ],
        preview="curl -sLI {}",
    ),
)

`class Fzf` vs. `function fzf_prompt`

In the above examples, two very different classes and functions are being used.

The class Fzf is a raw interface to fzf. It is mainly suited for instances where you would want to get total control over the fzf process, i.e. adding more results and such.

During raw declaraction, it will take cli directly from you. To get automatic parsing, you may use the .load_with_options class method. This will automatically handle keyword arguments and translate them to fzf arguments.

The function fzf_prompt is a helper function built over the class. It will handle processing and stdout prompts automatically so that you don't need to mess around much with how data is passed to fzf.

The class may also be used as a context manager for that syntactic sugar.

Overriding executable

You will be able to change where your fzf executable is located.

from fzf import process

process.EXECUTABLE = "here/is/my/fzf"

In a nutshell,

Compared to whatever Python support is available at the moment, this project reigns supreme.

shawnkoh/fzf.py