Skip to main content

A Python library for interacting with FZF.

Project description

pre-commit

PyPI PyPI - Python Version PyPI - License

Tests

Read the Docs

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.

Project details


Download files

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

Source Distribution

fzflib-0.1.17.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

fzflib-0.1.17-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file fzflib-0.1.17.tar.gz.

File metadata

  • Download URL: fzflib-0.1.17.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.1

File hashes

Hashes for fzflib-0.1.17.tar.gz
Algorithm Hash digest
SHA256 f210c619ccf752a0dfc65dbf55f340624131337e4183a89ed1ecce52397d4ce5
MD5 6a8eeea22b2eb4d480c7aa2c11c9b21d
BLAKE2b-256 9b5cda9c22563a064ff3f0d7752bd38abd5eff6bbb3c6264165d89f45757f1a5

See more details on using hashes here.

File details

Details for the file fzflib-0.1.17-py3-none-any.whl.

File metadata

  • Download URL: fzflib-0.1.17-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.1

File hashes

Hashes for fzflib-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 db6fb14ef70f84d3c9aacf3348cab0eb71118cbcf9373846aee6e64f8a79a3bf
MD5 b6a8fe60d56200c01d1c71532023df14
BLAKE2b-256 8a06a88699b2f9167abc28313c036768471f9e4540dfe69c53a842b6da87c0d0

See more details on using hashes here.

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