https://github.com/lwanger/cooked_input
Cooked Input library for getting and validating input from the command line.
https://github.com/lwanger/cooked_input
input-validation python python-3 python-lib
Last synced: 9 months ago
JSON representation
Cooked Input library for getting and validating input from the command line.
- Host: GitHub
- URL: https://github.com/lwanger/cooked_input
- Owner: lwanger
- License: mit
- Created: 2017-06-23T07:39:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-21T14:39:09.000Z (almost 2 years ago)
- Last Synced: 2025-04-06T22:39:21.199Z (9 months ago)
- Topics: input-validation, python, python-3, python-lib
- Language: Python
- Size: 412 KB
- Stars: 20
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
.. 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 `_
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 `_ and `part two `_) 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+ (with 3.9 being the latest tested)
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