143 lines
5.2 KiB
Plaintext
143 lines
5.2 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
|
Name: questionary
|
||
|
|
Version: 2.0.1
|
||
|
|
Summary: Python library to build pretty command line user prompts ⭐️
|
||
|
|
Home-page: https://github.com/tmbo/questionary
|
||
|
|
License: MIT
|
||
|
|
Keywords: cli,ui,inquirer,questions,prompt
|
||
|
|
Author: Tom Bocklisch
|
||
|
|
Author-email: tombocklisch@gmail.com
|
||
|
|
Maintainer: Tom Bocklisch
|
||
|
|
Maintainer-email: tombocklisch@gmail.com
|
||
|
|
Requires-Python: >=3.8
|
||
|
|
Classifier: Development Status :: 4 - Beta
|
||
|
|
Classifier: Intended Audience :: Developers
|
||
|
|
Classifier: License :: OSI Approved :: MIT License
|
||
|
|
Classifier: Programming Language :: Python
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: Programming Language :: Python :: 3.8
|
||
|
|
Classifier: Programming Language :: Python :: 3.9
|
||
|
|
Classifier: Programming Language :: Python :: 3.10
|
||
|
|
Classifier: Programming Language :: Python :: 3.11
|
||
|
|
Classifier: Topic :: Software Development :: Libraries
|
||
|
|
Requires-Dist: prompt_toolkit (>=2.0,<=3.0.36)
|
||
|
|
Project-URL: Documentation, https://questionary.readthedocs.io/
|
||
|
|
Project-URL: Repository, https://github.com/tmbo/questionary
|
||
|
|
Description-Content-Type: text/markdown
|
||
|
|
|
||
|
|
# Questionary
|
||
|
|
|
||
|
|
[](https://pypi.org/project/questionary/)
|
||
|
|
[](#)
|
||
|
|
[](#)
|
||
|
|
[](https://coveralls.io/github/tmbo/questionary?branch=master)
|
||
|
|
[](https://pypi.python.org/pypi/questionary)
|
||
|
|
[](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)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
```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.
|
||
|
|
|