Description

Bring the incredible utility of FZF to Python.

Probably one of the best tools I've ever found.

Installation

Using the official The Python Package Index (PyPI).

pip install fzflib

Requirements

Documentation

View the documentation at Read the Docs

Usage

Create an FZF instance.

fzf = FZF()

Create an FZF instance, with additional options during instantiation.

fzf = FZF(fzf='~/fzf.exe', multi=True)

Change Options

Use the FZF instance to search for various options.

fzf.input = ['option 1', 'option 2']
fzf.prompt()

Set different working directory, when running FZF.

fzf.cwd: PathLike = '~'

Command Line Utility

Use the FZF Python class as a command line utility.

Note that FZF is already a command line utility and is far more powerful than this package when used from the command line.

$ py -m fzflib --help

usage: __main__.py [-h] [--multi]

optional arguments:
  -h, --help  show this help message and exit
  --multi     Mutliple selections. Default: False

Install FZF

This will attempt to install FZF on your machine.

FZF.install()

Contribution

This package follows a similar style found in the Python standard library of using a central class, or set of classes, to generate a set of useful functions (e.g. difflib).

Feel free to submit an Issue for any bugs, or suggestions.

Support the people behind FZF.

AceofSpades5757 / fzflib