{
"info": {
"author": "Tom Bocklisch",
"author_email": "tombocklisch@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Topic :: Software Development :: Libraries"
],
"description": "# questionary\n\n[](https://pypi.org/project/questionary/)\n[](https://pypi.org/project/questionary/)\n[](https://travis-ci.com/tmbo/questionary)\n[](https://coveralls.io/github/tmbo/questionary?branch=master)\n[](https://pypi.python.org/pypi/questionary)\n[](https://app.fossa.io/projects/git%2Bgithub.com%2Ftmbo%2Fquestionary?ref=badge_shield)\n\n\nPython library to build pretty command line user prompts \u2728\n\nYou need input from a user, e.g. how an output file should be named or if he really wants to execute that dangerous operation? This library will help you make the input prompts easy to read and answer for the user.\n\nUsed and Supported by:\n\n[![](\"https://rasa.com/docs/_static/rasa_logo.svg\")
](https://github.com/RasaHQ/rasa)\n\n## Quickstart\n\nTo install `questionary`, simply use [pipenv](http://pipenv.org/) (or pip, of\ncourse):\n\n```bash\n$ pipenv install questionary\n\u2728\ud83c\udf82\u2728\n```\n\nSatisfaction guaranteed. Let's create a first question:\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\nThis will create the following list, allowing the user to choose an option:\n\n![](\"docs/images/example.gif\")
\n\n## Documentation\n\n### Different question types\n\ntext
\n\n A free text input for the user.\n\n ```python\n questionary.text(\"What's your first name\").ask()\n ```\n ![](\"docs/images/text.png\")
\n\npassword
\n\n A free text input for the user where the input is not\n shown but replaced with `***`.\n\n ```python\n questionary.password(\"What's your secret?\").ask()\n ```\n\n ![](\"docs/images/password.png\")
\n\nconfirm
\n\n A yes or no question. The user can either confirm or deny.\n\n ```python\n questionary.confirm(\"Are you amazed?\").ask()\n ```\n\n ![](\"docs/images/confirm.png\")
\n\nselect
\n\n A list of items to select a choice from. The user can pick\n one option and confirm it.\n\n ```python\n questionary.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()\n ```\n\n ![](\"docs/images/select.png\")
\n\nrawselect
\n\n A list of items to select a choice from. The user can pick\n one option using shortcuts and confirm it.\n\n ```python\n questionary.rawselect(\n \"What do you want to do?\",\n choices=[\n \"Order a pizza\",\n \"Make a reservation\",\n \"Ask for opening hours\"\n ]).ask()\n ```\n\n ![](\"docs/images/rawselect.png\")
\n\ncheckbox
\n\n A list of items to select multiple choices from. The user can pick\n none, one or multiple options and confirm the selection.\n\n ```python\n questionary.checkbox(\n 'Select toppings',\n choices=[\n \"foo\",\n \"bar\",\n \"bazz\"\n ]).ask()\n ```\n ![](\"docs/images/checkbox.png\")
\n\nSkipping questions using conditions
\n\nSometimes it is helpfull to e.g. provide a command line flag to your app\nto skip any prompts, to avoid the need for an if around any question you\ncan pass that flag when you create the question:\n\n```python\nDISABLED = True\n\nresponse = questionary.confirm(\"Are you amazed?\").skip_if(DISABLED, default=True).ask()\n```\n\nIf the condition (in this case `DISABLED`) is `True`, the question will be\nskipped and the default value gets returned, otherwise the user will be\nprompted as usual and the default value will be ignored.\nAlterative style to create questions using a configuration dictionary
\n\nInstead of creating questions using the python functions, you can also create them using a configuration dictionary.\n```python\nquestions = [\n {\n 'type': 'text',\n 'name': 'phone',\n 'message': \"What's your phone number\",\n },\n {\n 'type': 'confirm',\n 'message': 'Do you want to continue?',\n 'name': 'continue',\n 'default': True,\n }\n]\n\nanswers = prompt(questions)\n```\n\nThe returned `answers` will be a dict containing the responses, e.g. `{\"phone\": \"0123123\", \"continue\": False, \"\"}`. The questions will be prompted one after another and `prompt` will return once all of them are answered.\nStyling your prompts with your favorite colors
\n\nYou can customize all the colors used for the prompts. Every part of the prompt has an identifier, which you can use to style it. Let's create our own custom style:\n```python\nfrom prompt_toolkit.styles import Style\n\ncustom_style_fancy = Style([\n ('qmark', 'fg:#673ab7 bold'), # token in front of the question\n ('question', 'bold'), # question text\n ('answer', 'fg:#f44336 bold'), # submitted answer text behind the question\n ('pointer', 'fg:#673ab7 bold'), # pointer used in select and checkbox prompts\n ('highlighted', 'fg:#673ab7 bold'), # pointed-at choice in select and checkbox prompts if use_pointer=False\n ('selected', 'fg:#cc5454'), # style for a selected item of a checkbox\n ('separator', 'fg:#cc5454'), # separator in lists\n ('instruction', ''), # user instructions for select, rawselect, checkbox\n ('text', ''), # plain text\n ('disabled', 'fg:#858585 italic') # disabled choices for select and checkbox prompts\n])\n```\n\nTo use our custom style, we need to pass it to the question type:\n```python\nquestionary.text(\"What's your phone number\", style=custom_style_fancy).ask()\n```\n\nIt is also possible to use a list of token tuples as a `Choice` title. This\nexample assumes there is a style token named `bold` in the custom style you are\nusing:\n```python\nChoice(\n title=[\n ('class:text', 'plain text '),\n ('class:bold', 'bold text')\n ]\n)\n```\nAs you can see it is possible to use custom style tokens for this purpose as\nwell. Note that Choices with token tuple titles will not be styled by the\n`selected` or `highlighted` tokens. If not provided, the `value` of the Choice\nwill be the text concatenated (`'plain text bold text'` in the above example).\nunreleased (master branch)
\n\n1.3.0 (25.08.2019)
\n\nFeature release.\n\n* Add additional options to style checkboxe and select prompts https://github.com/tmbo/questionary/pull/14\n\n1.2.1 (19.08.2019)
\n\nBug fix release.\n\n* Fixed compatibility with python 3.5.2 by removing `Type` annotation (this time for real)\n1.2.0 (30.07.2019)
\n\nFeature release.\n\n* Allow a user to pass in a validator as an instance https://github.com/tmbo/questionary/pull/10\n\n1.1.1 (21.04.2019)
\n\nBug fix release.\n\n* Fixed compatibility with python 3.5.2 by removing `Type` annotation\n\n1.1.0 (10.03.2019)
\n\nFeature release.\n\n* Added `skip_if` to questions to allow skipping questions using a flag\n\n\n1.0.2 (23.01.2019)
\n\nBug fix release.\n\n* Fixed odd behaviour if select is created without providing any choices\n instead, we will raise a `ValueError` now. ([#6](https://github.com/tmbo/questionary/pull/6))\n\n\n1.0.1 (12.01.2019)
\n\nBug fix release, adding some convenience shortcuts.\n\n* Added shortcut keys `j` (move down^ the list) and `k` (move up) to\n the prompts `select` and `checkbox` (fixes [#2](https://github.com/tmbo/questionary/issues/2))\n* Fixed unclosed file handle in `setup.py`\n* Fixed unecessary empty lines moving selections to far down (fixes [#3](https://github.com/tmbo/questionary/issues/3))\n\n1.0.0 (14.12.2018)
\n\nInitial public release of the library\n\n* Added python interface\n* Added dict style question creation\n* Improved the documentation\n* More tests and automatic travis test execution\n