freshcrate
Home > Frameworks > questionary

questionary

Python library to build pretty command line user prompts ā­ļø

Description

# Questionary [![Version](https://img.shields.io/pypi/v/questionary.svg)](https://pypi.org/project/questionary/) [![License](https://img.shields.io/pypi/l/questionary.svg)](#) [![Continuous Integration](https://github.com/tmbo/questionary/workflows/Continuous%20Integration/badge.svg)](#) [![Coverage](https://coveralls.io/repos/github/tmbo/questionary/badge.svg?branch=master)](https://coveralls.io/github/tmbo/questionary?branch=master) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/questionary.svg)](https://pypi.python.org/pypi/questionary) [![Documentation](https://readthedocs.org/projects/questionary/badge/?version=latest)](https://questionary.readthedocs.io/en/latest/?badge=latest) ✨ Questionary is a Python library for effortlessly building pretty command line interfaces ✨ * [Features](#features) * [Installation](#installation) * [Usage](#usage) * [Documentation](#documentation) * [Support](#support) ![Example](https://raw.githubusercontent.com/tmbo/questionary/master/docs/images/example.gif) ```python3 import questionary questionary.text("What's your first name").ask() questionary.password("What's your secret?").ask() questionary.confirm("Are you amazed?").ask() questionary.select( "What do you want to do?", choices=["Order a pizza", "Make a reservation", "Ask for opening hours"], ).ask() questionary.rawselect( "What do you want to do?", choices=["Order a pizza", "Make a reservation", "Ask for opening hours"], ).ask() questionary.checkbox( "Select toppings", choices=["foo", "bar", "bazz"] ).ask() questionary.path("Path to the projects version file").ask() ``` Used and supported by [<img src="https://raw.githubusercontent.com/tmbo/questionary/master/docs/images/rasa-logo.svg" width="200">](https://github.com/RasaHQ/rasa) ## Features Questionary supports the following input prompts: * [Text](https://questionary.readthedocs.io/en/stable/pages/types.html#text) * [Password](https://questionary.readthedocs.io/en/stable/pages/types.html#password) * [File Path](https://questionary.readthedocs.io/en/stable/pages/types.html#file-path) * [Confirmation](https://questionary.readthedocs.io/en/stable/pages/types.html#confirmation) * [Select](https://questionary.readthedocs.io/en/stable/pages/types.html#select) * [Raw select](https://questionary.readthedocs.io/en/stable/pages/types.html#raw-select) * [Checkbox](https://questionary.readthedocs.io/en/stable/pages/types.html#checkbox) * [Autocomplete](https://questionary.readthedocs.io/en/stable/pages/types.html#autocomplete) There is also a helper to [print formatted text](https://questionary.readthedocs.io/en/stable/pages/types.html#printing-formatted-text) for when you want to spice up your printed messages a bit. ## Installation Use the package manager [pip](https://pip.pypa.io/en/stable/) to install Questionary: ```bash pip install questionary ``` āœØšŸŽ‚āœØ ## Usage ```python import questionary questionary.select( "What do you want to do?", choices=[ 'Order a pizza', 'Make a reservation', 'Ask for opening hours' ]).ask() # returns value of selection ``` That's all it takes to create a prompt! Have a [look at the documentation](https://questionary.readthedocs.io/) for some more examples. ## Documentation Documentation for Questionary is available [here](https://questionary.readthedocs.io/). ## Support Please [open an issue](https://github.com/tmbo/questionary/issues/new) with enough information for us to reproduce your problem. A [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) would be very helpful. ## Contributing Contributions are very much welcomed and appreciated. Head over to the documentation on [how to contribute](https://questionary.readthedocs.io/en/stable/pages/contributors.html#steps-for-submitting-code). ## Authors and Acknowledgment Questionary is written and maintained by Tom Bocklisch and Kian Cross. It is based on the great work by [Oyetoke Toby](https://github.com/CITGuru/PyInquirer) and [Mark Fink](https://github.com/finklabs/whaaaaat). ## License Licensed under the [MIT License](https://github.com/tmbo/questionary/blob/master/LICENSE). Copyright 2021 Tom Bocklisch.

Release History

VersionChangesUrgencyDate
2.1.1Imported from PyPI (2.1.1)Low4/21/2026
2.1.0Tag 2.1.0Low12/29/2024
2.0.1Tag 2.0.1Low9/8/2023
2.0.0Tag 2.0.0Low8/10/2023
1.10.0Tag 1.10.0Low7/15/2021
1.9.0Tag 1.9.0Low12/20/2020
1.8.1Tag 1.8.1Low11/17/2020
1.8.0Tag 1.8.0Low11/8/2020
1.7.0Tag 1.7.0Low10/15/2020
1.6.0Tag 1.6.0Low10/4/2020
1.5.2Tag 1.5.2Low4/17/2020
1.5.1Tag 1.5.1Low1/22/2020
1.5.0Tag 1.5.0Low1/22/2020
1.4.0Tag 1.4.0Low11/10/2019
1.3.0Tag 1.3.0Low8/25/2019
1.2.1Tag 1.2.1Low8/19/2019
1.2.0Tag 1.2.0Low7/30/2019
1.1.1Tag 1.1.1Low4/21/2019
1.1.0Tag 1.1.0Low4/10/2019
1.0.2Tag 1.0.2Low1/23/2019

Dependencies & License Audit

Loading dependencies...

Similar Packages

inquirerpyPython port of Inquirer.js (A collection of common interactive command-line user interfaces)0.3.4
@os-eco/canopy-cliGit-native prompt management for AI agent workflows0.2.3
pre-commitA framework for managing and maintaining multi-language pre-commit hooks.v4.6.0
azure-core-tracing-opentelemetryMicrosoft Azure Azure Core OpenTelemetry plugin Library for Pythonazure-template_0.1.0b6187637
spdx-toolsSPDX parser and tools.0.8.5