Pick an option in the terminal with a simple GUI
Project description
pick
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 fromtitle
: (optional) a title above options listindicator
: (optional) custom the selection indicator, defaults to*
default_index
: (optional) set this if the default selected option is not the first onemultiselect
: (optional), if set to True its possible to select multiple items by hitting SPACEmin_selection_count
: (optional) for multi select feature to dictate a minimum of selected items before continuingscreen
: (optional), if you are usingpick
within an existing curses application set this to your existingscreen
object. It is assumed this has initialised in the standard way (e.g. viacurses.wrapper()
, orcurses.noecho(); curses.cbreak(); screen.kepad(True)
)position
: (optional), if you are usingpick
within an existing curses application use this to set the first position to write to. e.g.,position=pick.Position(y=1, x=1)
quit_keys
: (optional), if you want to quit early, you can pass a key codes. If the corresponding key are pressed, it will quit the menu.
Community Projects
pickpack: A fork of pick
to select tree data.
Project details
Release history Release notifications | RSS feed
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.4.0b1.tar.gz
(5.0 kB
view details)
Built Distribution
File details
Details for the file pick-2.4.0b1.tar.gz
.
File metadata
- Download URL: pick-2.4.0b1.tar.gz
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.4 Darwin/23.2.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63fd5896a4c66e2bbd8791d33a726716b737c14153dca83e337c74c777623d1b |
|
MD5 | e96f3ddb9d22463aa667722127e780de |
|
BLAKE2b-256 | 8e428c68f3fb9d815451b7739a16729ed567f96c2f659948a3a08a59c2e2e6c7 |
File details
Details for the file pick-2.4.0b1-py3-none-any.whl
.
File metadata
- Download URL: pick-2.4.0b1-py3-none-any.whl
- Upload date:
- Size: 5.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.4 Darwin/23.2.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80324c11246d6a661863c61d47947047bbee28948bf9f85f7c8df88d3677ed41 |
|
MD5 | fe98ee15fe3ceb47eb0aec38cb174781 |
|
BLAKE2b-256 | 6bc0a5d6e558fdff58e039bd22ef62c475b553401e021d7079702941c51ce8eb |