# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/tmbo/questionary",
"name": "questionary",
"maintainer": "Tom Bocklisch",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "tombocklisch@gmail.com",
"keywords": "cli,ui,inquirer,questions,prompt",
"author": "Tom Bocklisch",
"author_email": "tombocklisch@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/84/d0/d73525aeba800df7030ac187d09c59dc40df1c878b4fab8669bdc805535d/questionary-2.0.1.tar.gz",
"platform": null,
"description": "# Questionary\n\n[](https://pypi.org/project/questionary/)\n[](#)\n[](#)\n[](https://coveralls.io/github/tmbo/questionary?branch=master)\n[](https://pypi.python.org/pypi/questionary)\n[](https://questionary.readthedocs.io/en/latest/?badge=latest)\n\n\u2728 Questionary is a Python library for effortlessly building pretty command line interfaces \u2728\n\n* [Features](#features)\n* [Installation](#installation)\n* [Usage](#usage)\n* [Documentation](#documentation)\n* [Support](#support)\n\n\n\n\n```python3\nimport questionary\n\nquestionary.text(\"What's your first name\").ask()\nquestionary.password(\"What's your secret?\").ask()\nquestionary.confirm(\"Are you amazed?\").ask()\n\nquestionary.select(\n \"What do you want to do?\",\n choices=[\"Order a pizza\", \"Make a reservation\", \"Ask for opening hours\"],\n).ask()\n\nquestionary.rawselect(\n \"What do you want to do?\",\n choices=[\"Order a pizza\", \"Make a reservation\", \"Ask for opening hours\"],\n).ask()\n\nquestionary.checkbox(\n \"Select toppings\", choices=[\"foo\", \"bar\", \"bazz\"]\n).ask()\n\nquestionary.path(\"Path to the projects version file\").ask()\n```\n\nUsed and supported by\n\n[<img src=\"https://raw.githubusercontent.com/tmbo/questionary/master/docs/images/rasa-logo.svg\" width=\"200\">](https://github.com/RasaHQ/rasa)\n\n## Features\n\nQuestionary supports the following input prompts:\n \n * [Text](https://questionary.readthedocs.io/en/stable/pages/types.html#text)\n * [Password](https://questionary.readthedocs.io/en/stable/pages/types.html#password)\n * [File Path](https://questionary.readthedocs.io/en/stable/pages/types.html#file-path)\n * [Confirmation](https://questionary.readthedocs.io/en/stable/pages/types.html#confirmation)\n * [Select](https://questionary.readthedocs.io/en/stable/pages/types.html#select)\n * [Raw select](https://questionary.readthedocs.io/en/stable/pages/types.html#raw-select)\n * [Checkbox](https://questionary.readthedocs.io/en/stable/pages/types.html#checkbox)\n * [Autocomplete](https://questionary.readthedocs.io/en/stable/pages/types.html#autocomplete)\n\nThere is also a helper to [print formatted text](https://questionary.readthedocs.io/en/stable/pages/types.html#printing-formatted-text)\nfor when you want to spice up your printed messages a bit.\n\n## Installation\n\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install Questionary:\n\n```bash\n$ pip install questionary\n\u2728\ud83c\udf82\u2728\n```\n\n## Usage\n\n```python\nimport questionary\n\nquestionary.select(\n \"What do you want to do?\",\n choices=[\n 'Order a pizza',\n 'Make a reservation',\n 'Ask for opening hours'\n ]).ask() # returns value of selection\n```\n\nThat's all it takes to create a prompt! Have a [look at the documentation](https://questionary.readthedocs.io/)\nfor some more examples.\n\n## Documentation\n\nDocumentation for Questionary is available [here](https://questionary.readthedocs.io/).\n\n## Support\n\nPlease [open an issue](https://github.com/tmbo/questionary/issues/new)\nwith enough information for us to reproduce your problem.\nA [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)\nwould be very helpful.\n\n## Contributing\n\nContributions 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).\n\n## Authors and Acknowledgment\n\nQuestionary is written and maintained by Tom Bocklisch and Kian Cross.\n\nIt is based on the great work by [Oyetoke Toby](https://github.com/CITGuru/PyInquirer) \nand [Mark Fink](https://github.com/finklabs/whaaaaat).\n\n## License\nLicensed under the [MIT License](https://github.com/tmbo/questionary/blob/master/LICENSE). Copyright 2021 Tom Bocklisch.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python library to build pretty command line user prompts \u2b50\ufe0f",
"version": "2.0.1",
"project_urls": {
"Documentation": "https://questionary.readthedocs.io/",
"Homepage": "https://github.com/tmbo/questionary",
"Repository": "https://github.com/tmbo/questionary"
},
"split_keywords": [
"cli",
"ui",
"inquirer",
"questions",
"prompt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0be72dd8f59d1d328773505f78b85405ddb1cfe74126425d076ce72e65540b8b",
"md5": "f2b7f9272fa1a54834418bfbd10ce475",
"sha256": "8ab9a01d0b91b68444dff7f6652c1e754105533f083cbe27597c8110ecc230a2"
},
"downloads": -1,
"filename": "questionary-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f2b7f9272fa1a54834418bfbd10ce475",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 34248,
"upload_time": "2023-09-08T12:19:01",
"upload_time_iso_8601": "2023-09-08T12:19:01.612201Z",
"url": "https://files.pythonhosted.org/packages/0b/e7/2dd8f59d1d328773505f78b85405ddb1cfe74126425d076ce72e65540b8b/questionary-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "84d0d73525aeba800df7030ac187d09c59dc40df1c878b4fab8669bdc805535d",
"md5": "2ca6f5b8299edbce76a72fb450c3f53e",
"sha256": "bcce898bf3dbb446ff62830c86c5c6fb9a22a54146f0f5597d3da43b10d8fc8b"
},
"downloads": -1,
"filename": "questionary-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "2ca6f5b8299edbce76a72fb450c3f53e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 24726,
"upload_time": "2023-09-08T12:19:03",
"upload_time_iso_8601": "2023-09-08T12:19:03.316219Z",
"url": "https://files.pythonhosted.org/packages/84/d0/d73525aeba800df7030ac187d09c59dc40df1c878b4fab8669bdc805535d/questionary-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-08 12:19:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tmbo",
"github_project": "questionary",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "questionary"
}
JSON
