InquirerPy
Documentation: inquirerpy.readthedocs.io
Introduction
InquirerPy is a Python port of the famous Inquirer.js (A collection of common interactive command line user interfaces).
This project is a re-implementation of the PyInquirer project, with bug fixes of known issues, new prompts, backward compatible APIs
as well as more customisation options.
Motivation
PyInquirer is a great Python port of Inquirer.js, however, the project is slowly reaching to an unmaintained state with various issues left behind and no intention to implement more feature requests. I was heavily relying on this library for other projects but could not proceed due to the limitations.
Some noticeable ones that bother me the most:
- hard limit on
prompt_toolkitversion 1.0.3 - various color issues
- various cursor issues
- No options for VI/Emacs navigation key bindings
- Pagination option doesn't work
This project uses python3.7+ type hinting with focus on resolving above issues while providing greater customisation options.
Requirements
OS
Leveraging prompt_toolkit, InquirerPy works cross platform for all OS. Although Unix platform may have a better experience than Windows.
Python
python >= 3.7
Getting Started
Checkout full documentation here.
Install
pip3 install InquirerPyQuick Start
Classic Syntax (PyInquirer)
from InquirerPy import prompt
questions = [
{"type": "input", "message": "What's your name:", "name": "name"},
{"type": "confirm", "message": "Confirm?", "name": "confirm"},
]
result = prompt(questions)
name = result["name"]
confirm = result["confirm"]Alternate Syntax
from InquirerPy import inquirer
name = inquirer.text(message="What's your name:").execute()
confirm = inquirer.confirm(message="Confirm?").execute()Migrating from PyInquirer
Most APIs from PyInquirer should be compatible with InquirerPy. If you have discovered more incompatible APIs, please
create an issue or directly update README via a pull request.
EditorPrompt
InquirerPy does not support editor prompt as of now.
CheckboxPrompt
The following table contains the mapping of incompatible parameters.
| PyInquirer | InquirerPy |
|---|---|
| pointer_sign | pointer |
| selected_sign | enabled_symbol |
| unselected_sign | disabled_symbol |
Style
Every style keys from PyInquirer is present in InquirerPy except the ones in the following table.
| PyInquirer | InquirerPy |
|---|---|
| selected | pointer |
Although InquirerPy support all the keys from PyInquirer, the styling works slightly different.
Please refer to the Style documentation for detailed information.
Similar projects
questionary
questionary is a fantastic fork which supports prompt_toolkit 3.0.0+ with performance improvement and more customisation options.
It's already a well established and stable library.
Comparing with questionary, InquirerPy offers even more customisation options in styles, UI as well as key bindings. InquirerPy also provides a new
and powerful fuzzy prompt.
python-inquirer
python-inquirer is another great Python port of Inquirer.js. Instead of using prompt_toolkit, it
leverages the library blessed to implement the UI.
Before implementing InquirerPy, this library came up as an alternative. It's a more stable library comparing to the original PyInquirer, however
it has a rather limited customisation options and an older UI which did not solve the issues I was facing described in the Motivation section.
Comparing with python-inquirer, InquirerPy offers a slightly better UI,
more customisation options in key bindings and styles, providing pagination as well as more prompts.
Credit
This project is based on the great work done by the following projects & their authors.
License
This project is licensed under MIT.
