Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

A module for getting validated user input via the console

Project Description

* [[][cliask]]

A Python module for getting validated user input via the console which is meant to ease the process of building command line interfaces. Provides the function =ask= which will ask for input until a valid response is given. Also provides the function =agree= which will ask for input until the answer is yes or no. Both functions are similar to and inspired by the functions with the same name in the Ruby library [[][HighLine]]. The following code gives a peek of how the functions can be used:
import cliask

animal = cliask.ask('Cow or cat? ',
validator=('cow', 'cat'),
invalid_response='You must say cow or cat')
yn = cliask.agree('Yes or no? ')


** Installation

To use cliask you need Python 3. The following describes two ways of installing. The first method requires that =git= is installed and the second does not. Either way the module has to be [[][imported]] for it to be used.

*** pip

Make sure you have =pip= installed then do the following:
sudo pip install cliask

*** Git

=cd= to the directory you want to install in and do
git clone .
to clone the git repository into that directory. You can use the same command if you want to update your installation.

*** Archive

[[][Download]] an archive and extract to the directory you want to install in.

** Usage

See the documentation in [[][]], especially the documention for =cliask.ask= and the example of usage in =cliask._test=. Run, =python, to try the example of usage.

** Credits

The code in the module was first posted as [[][an answer]] to [[][a question]].

** License

See [[][]].

Release History

This version
History Node


Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Hash SHA256 Hash Help Version File Type Upload Date
(3.3 kB) Copy SHA256 Hash SHA256
Source Apr 9, 2013

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting