pick

pick is a small python library to help you create curses based interactive selection list in the terminal. See it in action:

Installation

$ pip install pick

Usage

pick comes with a simple api:

>>> from pick import pick

>>> title = 'Please choose your favorite programming language: '
>>> options = ['Java', 'JavaScript', 'Python', 'PHP', 'C++', 'Erlang', 'Haskell']
>>> option, index = pick(options, title)
>>> print option
>>> print index

outputs

>>> C++ 
>>> 4

pick multiselect example:

>>> from pick import pick

>>> title = 'Please choose your favorite programming language (press SPACE to mark, ENTER to continue): '
>>> options = ['Java', 'JavaScript', 'Python', 'PHP', 'C++', 'Erlang', 'Haskell']
>>> selected = pick(options, title, multi_select=True, min_selection_count=1)
>>> print selected

outputs

>>> [('Java', 0), ('C++', 4)]

Options

• options: a list of options to choose from
• title: (optional) a title above options list
• indicator: (optional) custom the selection indicator, defaults to *
• default_index: (optional) set this if the default selected option is not the first one
• multi_select: (optional), if set to True its possible to select multiple items by hitting SPACE
• min_selection_count: (optional) for multi select feature to dictate a minimum of selected items before continuing

Register custom handlers

sometimes you may need to register custom handlers to specific keys, you can use the register_custom_handler API:

>>> from pick import Picker
>>> title, options = 'Title', ['Option1', 'Option2']
>>> picker = Picker(options, title)
>>> def go_back(picker):
...     return None, -1
>>> picker.register_custom_handler(ord('h'),  go_back)
>>> option, index = picker.start()

• the custom handler will be called with the picker instance as it's parameter.
• the custom handler should either return a two element tuple, or None.
• if None is returned, the picker would continue to run, otherwise the picker will stop and return the tuple.