Metadata-Version: 2.1
Name: yorn
Version: 0.0.5
Summary: A boringly simple CLI input function.
Home-page: https://github.com/tslight/yorn
Author: Toby Slight
Author-email: tobyslight@gmail.com
License: UNKNOWN
Description: # GET A BINARY RESPONSE TO A QUESTION
        
        A very boring input reading package/library. Takes a question string as an
        argument and returns true if y or yes is entered, false if n or no is answered,
        and asks again if anything else is entered (other than q or quit which
        terminates the program.)
        
        I find this useful for getting user input in a script and got tired of
        re-writing it in every program so decided to create a package for it.
        
        ## INSTALLATION
        
        `pip install yorn`
        
        ## CLI USAGE
        
        ```
        usage: yorn [-h] question
        
        Answer yes or no to a question.
        
        positional arguments:
          question    A question to ask.
        
        optional arguments:
          -h, --help  show this help message and exit
        ```
        
        ![img](./yorn.png "Yorn")
        
        ## PYTHON USAGE
        
        ```python
        from yorn import ask
        
        question = "Would you like run my amazing program? "
        
        if ask(question):
        	run_my_amazing_function()
        else
        	print("Cookie monster is sad :-(")
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
