|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.
.. image:: https://raw.githubusercontent.com/jeffrimko/Qprompt/master/doc/demos/main_demo.gif
:alt: 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 <https://github.com/jeffrimko/Qprompt/blob/master/CHANGELOG.adoc>`__.
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 <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``
Documentation
=============
The full documentation for this project can be found `here on Read the
Docs <http://qprompt.readthedocs.io>`__.
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 <https://github.com/jeffrimko/Qprompt/blob/master/AUTHORS.adoc>`__.
Similar
=======
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
Raw data
{
"_id": null,
"home_page": "https://github.com/jeffrimko/Qprompt",
"name": "qprompt",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "cli menu prompt input user library",
"author": "Jeff Rimko",
"author_email": "jeffrimko@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8c/87/6d16deb372f272f253fc737f6e1935392c18a51850c47907235fcc65ed67/qprompt-0.16.3.tar.gz",
"platform": "",
"description": "|License| |Build Status| |Documentation Status|\n\nLibrary for quick CLI user prompts, input, and menus.\n\n\nIntroduction\n============\n\nThis project provides a Python 2.7/3.5+ library that allows the user to\nquickly create CLI prompts for user input. The main features of Qprompt\nare:\n\n- Simple multi-entry menus.\n\n- Prompt for typed (integer/float/string) input.\n\n- Optional default values and validity checks.\n\n- Various CLI convenience functions.\n\n- User input can optionally be supplied from script command-line\n arguments allowing for simple automation.\n\n- Should work on any platform without additional dependencies.\n\n.. image:: https://raw.githubusercontent.com/jeffrimko/Qprompt/master/doc/demos/main_demo.gif\n :alt: Demo\n\n\nStatus\n======\n\nCurrently, this project is in the **development release** stage. While\nthis project is suitable for use, please note that there may be\nincompatibilities in new releases.\n\nRelease notes are maintained in the project\n`changelog <https://github.com/jeffrimko/Qprompt/blob/master/CHANGELOG.adoc>`__.\n\n\nRequirements\n============\n\nQprompt should run on any Python 2.7/3.5+ interpreter and uses some\nthird-party libraries.\n\n\nInstallation\n============\n\nQprompt is `available on PyPI\nhere <https://pypi.python.org/pypi/qprompt>`__ and can be installed with\npip using the following command: ``pip install qprompt``\n\nAdditionally, Qprompt can be installed from source by running:\n``python setup.py install``\n\n\nDocumentation\n=============\n\nThe full documentation for this project can be found `here on Read the\nDocs <http://qprompt.readthedocs.io>`__.\n\n\nRoadmap\n=======\n\nThe following potential updates are under consideration:\n\n- Accept multiple menu choices from user at once; e.g. space separated\n entries like ``1 2 q``.\n\n- Timeouts for prompt inputs; default value used if timed out.\n\n\nContributing\n============\n\nContributions or feedback is welcome and encouraged!\n\nA list of those who have helped with this project is available in the\n`authors\nfile <https://github.com/jeffrimko/Qprompt/blob/master/AUTHORS.adoc>`__.\n\n\nSimilar\n=======\n\nThe following projects are similar and may be worth checking out:\n\n- `bullet <https://github.com/Mckinsey666/bullet>`__\n\n- `cliask <https://github.com/Sleft/cliask>`__\n\n- `Promptly <https://github.com/aventurella/promptly>`__\n\n- `python-inquirer <https://github.com/magmax/python-inquirer>`__\n\n- `python-prompt <https://github.com/sfischer13/python-prompt>`__\n\n- `python-prompt-toolkit <https://github.com/jonathanslenders/python-prompt-toolkit>`__\n\n- `prompter <https://github.com/tylerdave/prompter>`__\n\n- `Rich <https://github.com/willmcgugan/rich>`__\n\n.. |Qprompt| image:: doc/logo/qprompt.png\n.. |License| image:: http://img.shields.io/:license-mit-blue.svg\n.. |Build Status| image:: https://github.com/jeffrimko/Qprompt/workflows/tests/badge.svg\n.. |Documentation Status| image:: https://readthedocs.org/projects/qprompt/badge/?version=latest\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Library for quick CLI user prompts, input, and menus.",
"version": "0.16.3",
"project_urls": {
"Homepage": "https://github.com/jeffrimko/Qprompt"
},
"split_keywords": [
"cli",
"menu",
"prompt",
"input",
"user",
"library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8c876d16deb372f272f253fc737f6e1935392c18a51850c47907235fcc65ed67",
"md5": "f77d601ff9733accfae292083e28262c",
"sha256": "a375510899d7ccec143e919aef41c853afc61d9a43426c206595362d981cd171"
},
"downloads": -1,
"filename": "qprompt-0.16.3.tar.gz",
"has_sig": false,
"md5_digest": "f77d601ff9733accfae292083e28262c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10821,
"upload_time": "2021-11-20T03:17:53",
"upload_time_iso_8601": "2021-11-20T03:17:53.048918Z",
"url": "https://files.pythonhosted.org/packages/8c/87/6d16deb372f272f253fc737f6e1935392c18a51850c47907235fcc65ed67/qprompt-0.16.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-11-20 03:17:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jeffrimko",
"github_project": "Qprompt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "qprompt"
}
JSON
