GitLocker: The Coding Marketplace

Description:

limitedinteraction 0.2.2

Limited Interaction
import limitedinteraction as li

li.button_dialog("Simple dialog windows for scripters and scientists.",
choices=['OK'],
title='Limited Interaction',
icon='light')

This python module provides simple, generic dialog windows specifically aimed
to scripters and scientists who need a concise, elegant way of interacting with
their script users.
This module does not require any GUI programming, it has no external
dependency, and it is completely independent of the graphical backend in use
(if any). In IPython-based environments, its blocking functions allow
interacting with Matplotlib figures while waiting for user action.
For those transitionning from Matlab, this module fulfils the same role as
Matlab's msgbox, inputdlg, menu and other simple GUI functions.

Home page
GitHub
Issue tracker
API

Installing
Using pip:
pip install limitedinteraction

Using conda:
conda install -c conda-forge limitedinteraction

Usage
Importing
import limitedinteraction as li

Creating a persistent message window
li.message('Please wait a few moments.',
title='Calculating...',
icon='clock')

This is a non-blocking function. Any code after this call is executed
immediately, while this message window stays in foreground. To close the
message window:
li.message('')

Asking for user input
name = li.input_dialog('What is your name?', icon='question')

This is a blocking function. We wait for user input before continuing.
Meanwhile, Matplotlib's event loop is refreshed so that the user can
interact with figures.
This same function can have several inputs and some inputs can be masked:
credentials = li.input_dialog('Please enter your credentials',
labels=['Username:', 'Password:'],
initial_values=['username', 'password'],
masked=[False, True],
icon='lock')

choice_index = li.button_dialog('Please zoom on the figure and click Next.',
choices=['Next', 'Cancel'],
title='User interaction',
icon='gear')

This is a blocking function. We wait for a choice before continuing. Meanwhile,
Matplotlib's event loop is refreshed so that the user can interact with
figures.
Other functions
Get a file name using the operating system's standard file selection window:
filename = li.get_filename()

Get a folder name using the operating system's standard folder selection
window:
folder = li.get_folder()

Credits
This module is developed by Félix Chénier at the Mobility and Adaptive
Sports Research Lab (https://felixchenier.uqam.ca).
It includes artwork developed by these designers:

Warning and gear icons: Laura Reen
Question mark icon: Design Revision
All other icons: Recep Kütük