typing-filter 0.1.1

Simple CLI to provide choices to a user, and let them type in phrases which filters possible options.

Typing Filter

Simple CLI for a typing filter to provide choices to a user and let them type in phrases which filters possible options.

Status: in progress · Notion Roadmap »

https://user-images.githubusercontent.com/6320907/230550634-3ac6b92a-bbd2-4723-93ce-218ad02d8a31.mov

Installation

Install the package from PyPi via pip

pip install typing-filter

(back to top)

Usage

With a list of options ready, a list of descriptions, just import the package call the launch function.

import typing_filter
options = ['Alaska', 'Massachusetts', 'California']
descriptions = [None, 'My home state', 'My current state']
choice = typing_filter.launch(options, descriptions)

The selected choice is returned by the launch function, and is None if the operation was canceled.

Additional options can be made by tweaking the launch command:

import typing_filter
options = ['Alaska', 'Massachusetts', 'California']
descriptions = [None, 'My home state', 'My current state']
choice = typing_filter.launch(
  options, descriptions,
  description_separator=': ',
  header='Press Escape to quit!',
  prompt='Input:',
  selector='==>>', selector_padding=3
)

(back to top)

Roadmap

Refer to the Notion Roadmap for future features and the state of the project.

(back to top)

Contact

Created by Jonathan Delgado.

(back to top)