magmax/python-inquirer


A collection of common interactive command line user interfaces, based on Inquirer.js (https://github.com/SBoudrias/Inquirer.js/)

Language: Python


Tests Travis results Coveralls results_
Downloads Last month downloads from pypi Last week downloads from pypi Yesterday downloads from pypi
About License Wheel Python versions Python interpreters
Status Status Status

Collection of common interactive command line user interfaces, based on Inquirer.js.

Goal and Philosophy

Born as a Inquirer.js clone, it shares part of the goals and philosophy.

So, Inquirer should ease the process of asking end user questions, parsing, validating answers, managing hierarchical prompts and providing error feedback.

You can download the python-inquirer code from GitHub or download the wheel from Pypi.

Documentation

Documentation has been moved to ReadTheDocs.

But here you have a couple of usage examples:

Text

import inquirer
questions = [
  inquirer.Text('name', message="What's your name"),
  inquirer.Text('surname', message="What's your surname"),
  inquirer.Text('phone', message="What's your phone number",
                validate=lambda _, x: re.match('\+?\d[\d ]+\d', x),
                )
]
answers = inquirer.prompt(questions)

Example of Text Question

List

Shows a list of choices, and allows the selection of one of them.

Example:

import inquirer
questions = [
  inquirer.List('size',
                message="What size do you need?",
                choices=['Jumbo', 'Large', 'Standard', 'Medium', 'Small', 'Micro'],
            ),
]
answers = inquirer.prompt(questions)

List questions can take one extra argument carousel=False. If set to true, the answers will rotate (back to first when pressing down on last choice, and down to last choice when pressing up on first choice)

Example of List Question

Checkbox

Shows a list of choices, with multiple selection.

Example:

import inquirer
questions = [
  inquirer.Checkbox('interests',
                    message="What are you interested in?",
                    choices=['Computers', 'Books', 'Science', 'Nature', 'Fantasy', 'History'],
                    ),
]
answers = inquirer.prompt(questions)

Example of Checkbox Question

Path

Like Text question, but with builtin validations for working with paths.

Example:

import inquirer
questions = [
  inquirer.Path('log_file',
                 message="Where logs should be located?",
                 path_type=inquirer.Path.DIRECTORY,
                ),
]
answers = inquirer.prompt(questions)

License

Copyright (c) 2014 Miguel Ángel García (@magmax9), based on Inquirer.js, by Simon Boudrias (@vaxilart)

Licensed under the MIT license.

Project Statistics

Sourcerank 8
Repository Size 744 KB
Stars 194
Forks 33
Watchers 7
Open issues 19
Dependencies 14
Contributors 12
Tags 24
Created
Last updated
Last pushed

Top Contributors See all

Miguel Ángel García Vittorio Camisa matiboy Matt Warren Adam Uhlíř Steven Loria Emanuele Gaifas Aaron Fischer Patrick Browne Christian Fetzer Matthew Dotan J. Nahum

Packages Referencing this Repo

inquirer
Collection of common interactive command line user interfaces, based on Inquirer.js
Latest release 2.5.1 - Updated - 194 stars

Recent Tags See all

2.5.1 September 16, 2018
2.5.0 September 16, 2018
2.4.0 August 21, 2018
2.3.0 August 10, 2018
2.2.0 September 07, 2017
2.1.11 November 18, 2016
2.1.7 April 23, 2016
2.1.6 June 12, 2015
2.1.3 December 27, 2014
2.1.2 December 16, 2014
2.1.1 December 11, 2014
2.1.0 December 10, 2014
2.0.2 November 27, 2014
2.0.1 October 31, 2014
2.0.0 October 19, 2014

Something wrong with this page? Make a suggestion

Last synced: 2018-10-21 13:45:44 UTC

Login to resync this repository