Metadata-Version: 2.4
Name: qprompt
Version: 0.16.4
Summary: Library for quick CLI user prompts, input, and menus.
Project-URL: Homepage, https://github.com/jeffrimko/Qprompt
Project-URL: Documentation, https://qprompt.readthedocs.io
Project-URL: Changelog, https://github.com/jeffrimko/Qprompt/blob/master/CHANGELOG.adoc
Author-email: Jeff Rimko <jeffrimko@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: cli,input,library,menu,prompt,user
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Requires-Dist: iterfzf
Description-Content-Type: text/markdown

# ![Qprompt](doc/logo/qprompt.png)

[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/jeffrimko/Qprompt/blob/master/LICENSE)
[![Build Status](https://github.com/jeffrimko/Qprompt/actions/workflows/tests.yml/badge.svg)](https://github.com/jeffrimko/Qprompt/actions/workflows/tests.yml)
[![Documentation Status](https://readthedocs.org/projects/qprompt/badge/?version=latest)](https://qprompt.readthedocs.io/en/latest/)

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

## Introduction

This project provides a Python 3.8+ 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](https://raw.githubusercontent.com/jeffrimko/Qprompt/master/doc/demos/main_demo.gif)

## 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 3.8+ interpreter and uses some third-party libraries.

## Installation

Qprompt is [available on PyPI here](https://pypi.org/project/qprompt/) and can be installed with pip using the following command: `pip install qprompt`

Additionally, Qprompt can be installed from source by running: `pip install .`

## Documentation

The full documentation for this project can be found [here on Read the Docs](https://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)
