Skip to main content

Library for quick CLI user prompts, input, and menus.

Project description

License Build Status Documentation Status

Library for quick CLI user prompts, input, and menus.

Introduction

This project provides a Python 2.7/3.5+ library that allows the user to quickly create CLI prompts for user input. The main features of Qprompt are:

  • Simple multi-entry menus.

  • Prompt for typed (integer/float/string) input.

  • Optional default values and validity checks.

  • Various CLI convenience functions.

  • User input can optionally be supplied from script command-line arguments allowing for simple automation.

  • Should work on any platform without additional dependencies.

Demo

Status

Currently, this project is in the development release stage. While this project is suitable for use, please note that there may be incompatibilities in new releases.

Release notes are maintained in the project changelog.

Requirements

Qprompt should run on any Python 2.7/3.5+ interpreter and uses some third-party libraries.

Installation

Qprompt is available on PyPI here and can be installed with pip using the following command: pip install qprompt

Additionally, Qprompt can be installed from source by running: python setup.py install

Documentation

The full documentation for this project can be found here on Read the Docs.

Roadmap

The following potential updates are under consideration:

  • Accept multiple menu choices from user at once; e.g. space separated entries like 1 2 q.

  • Timeouts for prompt inputs; default value used if timed out.

Contributing

Contributions or feedback is welcome and encouraged!

A list of those who have helped with this project is available in the authors file.

Similar

The following projects are similar and may be worth checking out:

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

qprompt-0.16.3.tar.gz (10.8 kB view details)

Uploaded Source

File details

Details for the file qprompt-0.16.3.tar.gz.

File metadata

  • Download URL: qprompt-0.16.3.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.8

File hashes

Hashes for qprompt-0.16.3.tar.gz
Algorithm Hash digest
SHA256 a375510899d7ccec143e919aef41c853afc61d9a43426c206595362d981cd171
MD5 f77d601ff9733accfae292083e28262c
BLAKE2b-256 8c876d16deb372f272f253fc737f6e1935392c18a51850c47907235fcc65ed67

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