|License| |Build Status| |Documentation Status|
Library for quick CLI user prompts, input, and menus.
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.
.. image:: https://raw.githubusercontent.com/jeffrimko/Qprompt/master/doc/demos/main_demo.gif :alt: Demo
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 <https://github.com/jeffrimko/Qprompt/blob/master/CHANGELOG.adoc>__.
Qprompt should run on any Python 2.7/3.5+ interpreter and uses some third-party libraries.
Qprompt is available on PyPI here <https://pypi.python.org/pypi/qprompt>__ 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
The full documentation for this project can be found here on Read the Docs <http://qprompt.readthedocs.io>__.
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.
Contributions or feedback is welcome and encouraged!
A list of those who have helped with this project is available in the
authors file <https://github.com/jeffrimko/Qprompt/blob/master/AUTHORS.adoc>__.
The following projects are similar and may be worth checking out:
bullet <https://github.com/Mckinsey666/bullet>__
cliask <https://github.com/Sleft/cliask>__
Promptly <https://github.com/aventurella/promptly>__
python-inquirer <https://github.com/magmax/python-inquirer>__
python-prompt <https://github.com/sfischer13/python-prompt>__
python-prompt-toolkit <https://github.com/jonathanslenders/python-prompt-toolkit>__
prompter <https://github.com/tylerdave/prompter>__
Rich <https://github.com/willmcgugan/rich>__
.. |Qprompt| image:: doc/logo/qprompt.png .. |License| image:: http://img.shields.io/:license-mit-blue.svg .. |Build Status| image:: https://github.com/jeffrimko/Qprompt/workflows/tests/badge.svg .. |Documentation Status| image:: https://readthedocs.org/projects/qprompt/badge/?version=latest
FAQs
Library for quick CLI user prompts, input, and menus.
We found that qprompt demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
