Metadata-Version: 2.1
Name: survey
Version: 2.2.0
Summary: A simple library for creating beautiful interactive prompts.
Home-page: https://github.com/Exahilosys/survey
License: MIT
Platform: UNKNOWN
Requires-Python: >=3.5
Requires-Dist: wrapio (>=0.3.5)
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'

✨ A simple library for creating beautiful interactive prompts.

.. image:: https://github.com/Exahilosys/survey/raw/master/images/showcase.gif

.. code-block:: py

    import survey

    name = survey.input('Username: ')
    password = survey.password('Password: ')
    actions = ('Call', 'Text', 'Exit')
    index = survey.select(actions, 'Chose an action: ')
    # if index == 0: elif index == 1: else: ...
    contacts = ('Squig', 'Zelan', 'Momo', 'Hamberg', 'Evan', 'Vonnie', 'Dwalon', 'Hacen')
    indexes = survey.select(contacts, 'Select recipients: ', multi = True)
    message = survey.input('Type messsage: ', multi = True)
    confirm = survey.confirm(f'Message is {len(message)} characters long. Send? ', default = True)

Features
--------

- **Pythonic**: friendly interface wrapped around simple functions.
- **Lightweight**: independent of any other prompt or visual libraries.
- **Adaptable**: works with any string formatting and window size.
- **Extensive**: packed with tweaks and features for any situation.

Installing
----------

.. code-block::

    pip3 install survey

Links
-----

- Check out the `documentation <https://survey.readthedocs.io>`_ for more details.
- Greatly inspired by `AlecAivazis's GoLang <https://github.com/AlecAivazis/survey>`_ library.

Suggestions and contributions are greatly appreciated!


