Skip to main content

Pick an option in the terminal with a simple GUI

Project description

pick

image PyPI PyPI

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

Basic Multiselect

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, multiselect=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
  • multiselect: (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
  • screen: (optional), if you are using pick within an existing curses application set this to your existing screen object. It is assumed this has initialised in the standard way (e.g. via curses.wrapper(), or curses.noecho(); curses.cbreak(); screen.kepad(True))

Community Projects

pickpack: A fork of pick to select tree data.

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

pick-2.2.0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

pick-2.2.0-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file pick-2.2.0.tar.gz.

File metadata

  • Download URL: pick-2.2.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.0 Darwin/22.1.0

File hashes

Hashes for pick-2.2.0.tar.gz
Algorithm Hash digest
SHA256 96920ebcfb9b8b6c2e50d9f211a700e5036611904169587a5a9245a645637a0d
MD5 211f75b2a915c9d8c435962a28864b9d
BLAKE2b-256 5f0845f5bda20b9ad318c1cbeb911e9995e7357d4ae93cbfaccc8f2e40e96ec4

See more details on using hashes here.

File details

Details for the file pick-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: pick-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.0 Darwin/22.1.0

File hashes

Hashes for pick-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d301f358ee8eabe501795bb38a5160e05db68c0a89eb7ba38c7b667fc4673c8d
MD5 fb385f6ccec50cc1da229ddbc3b36c47
BLAKE2b-256 d6e867bd33eeeb1aad2013fa24b3e94c874a901337b86c52a0ac3764f12a86e1

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