Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tmbo/questionary

Python library to build pretty command line user prompts ✨Easy to use multi-select lists, confirmations, free text prompts ...
https://github.com/tmbo/questionary

hacktoberfest

Last synced: 10 days ago
JSON representation

Python library to build pretty command line user prompts ✨Easy to use multi-select lists, confirmations, free text prompts ...

Host: GitHub
URL: https://github.com/tmbo/questionary
Owner: tmbo
License: mit
Created: 2018-12-01T17:55:17.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-10-15T10:14:31.000Z (24 days ago)
Last Synced: 2024-10-16T09:44:03.201Z (23 days ago)
Topics: hacktoberfest
Language: Python
Homepage:
Size: 1.95 MB
Stars: 1,543
Watchers: 22
Forks: 87
Open Issues: 48
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

best-of-python - GitHub - 35% open · ⏱️ 12.01.2024): (CLI Development)
awesome-list - Questionary - A Python library for effortlessly building pretty command line interfaces. (Desktop App Development / Python Toolkit)

README

        # 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

[](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.