cooked-input

.. image:: https://img.shields.io/pypi/v/cooked_input.svg :target: https://pypi.org/project/cooked_input/

.. image:: https://img.shields.io/pypi/l/cooked_input.svg :target: https://pypi.org/project/cooked_input/

.. image:: https://readthedocs.org/projects/cooked_input/badge/?version=latest :target: https://pypi.org/project/cooked_input/

.. image:: https://img.shields.io/pypi/pyversions/cooked_input.svg :target: https://pypi.org/project/cooked_input/

Cooked Input Project

cooked_input is a Python package for getting, cleaning, converting, and validating input. If you think of input (raw_input in legacy Python) as raw input, then this is cooked input.

cooked_input provides a simple and safe way to get validated command line input that ranges from the simplest of Python programs to sophisticated database driven applications. Beginner's can use the provided convenience classes to get simple inputs from the user. Following the quick start guide <http://cooked-input.readthedocs.io/en/latest/quick_start.html>_ you can be up and running in minutes.

More advanced users can easily create custom classes for sophisticated cleaning and validation. Cooked_input can also be used to create menus and data tables. The latter tutorials (part one <http://cooked-input.readthedocs.io/en/latest/tutorial.html>_ and part two <http://cooked-input.readthedocs.io/en/latest/tutorial2.html>_) and examples show several examples ranging from simple to sophisticated calls.

Cooked_input also provides a pathway to use the same cleaning and validation logic used in the command line for validating web or GUI based inputs.

Documentation

The documentation is available at: http://cooked-input.readthedocs.io/en/latest/

Python 2/3 Support

cooked_input has been tested on Python: 2.7. 3.5+

Installation

pip install cooked_input

Project Page

Project information and source code is available at: https://github.com/lwanger/cooked_input

Tutorial

The best way to get started is to read the quick start at: http://cooked-input.readthedocs.io/en/latest/quick_start.html

After that, more advanced usage can be learned from the tutorial at: http://cooked-input.readthedocs.io/en/latest/tutorial.html