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))
  • position: (optional), if you are using pick within an existing curses application use this to set the first position to write to. e.g., position=pick.Position(y=1, x=1)

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.3.0.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

pick-2.3.0-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pick-2.3.0.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Darwin/21.6.0

File hashes

Hashes for pick-2.3.0.tar.gz
Algorithm Hash digest
SHA256 95221d577688f8aa4fa02f56a48c8186d3da1c9262a3a689cc6fd291768ff5e8
MD5 3c117d38f74abe3320a88df75104685d
BLAKE2b-256 1249d3dbd91c2fe3937644009cba60a405149622a9b3241044421ef954d0e9a9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pick-2.3.0-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Darwin/21.6.0

File hashes

Hashes for pick-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8017e7f58be9af85f139732cf7ffef1433ab6b862aa53b93ce21ea8e8c92f340
MD5 fdaf2a28bfe23dc4c62f61d82823d175
BLAKE2b-256 d1c4de5ad5f9482e753542efe700ae37babd632350ef1ebfdb5a4a4281cbc774

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