File: index.rst

package info (click to toggle)
python-questionary 2.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 960 kB
  • sloc: python: 3,917; makefile: 66
file content (55 lines) | stat: -rw-r--r-- 1,234 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
***********
Questionary
***********

✨ Questionary is a Python library for effortlessly building pretty command line interfaces ✨

It makes it very easy to query your user for input. You need your user to
confirm a destructive action or enter a file path? We've got you covered:

.. image:: images/example.gif

Creating your first prompt is just a few key strokes away

.. code-block:: python3

  import questionary

  first_name = questionary.text("What's your first name").ask()

This prompt will ask the user to provide free text input and the result is
stored in ``first_name``.

You can install Questionary using pip (for details, head over to the :ref:`installation` page):

.. code-block:: console

  $ pip install questionary

Ready to go? Check out the :ref:`quickstart`.

License
=======
Licensed under the `MIT License <https://github.com/tmbo/questionary/blob/master/LICENSE>`_.
Copyright 2020 Tom Bocklisch.

.. toctree::
   :hidden:
 
   pages/installation
   pages/quickstart
   pages/types
   pages/advanced
   pages/api_reference
   pages/support
   Examples <https://github.com/tmbo/questionary/tree/master/examples>

.. toctree::
   :hidden:

   pages/contributors

.. toctree::
   :hidden:

   pages/changelog