Metadata-Version: 2.1
Name: pexpectparser
Version: 0.1.1
Summary: A command line bot library using the pexpect library
Home-page: https://github.com/lorkaan/pexpectparser.git
Author: Laurkan Rodriguez
Author-email: laurkan@engineer.com
License: UNKNOWN
Download-URL: https://github.com/lorkaan/pexpectparser/archive/v0.1.1.tar.gz
Description: # Pexpect Parser
        
        A parser using the parsegrammar library to 
        create automated bots for command line programs.
        
        ## Examples
        
        An example of this code can be found in the following projects:
        - VPN Bot
        	- [Github](https://github.com/lorkaan/vpnBot)
        
        # Installation
        
        Pip installation is reccommended
        ```
        pip install -u pexpectparser
        ```
        
        Or if you are using PipEnv
        ```
        pipenv shell
        pipenv install pexpectparser
        ```
        
        # Usage
        
        ## Import
        ```
        import pexpectParser as pp
        ```
        
        ## Creating Class
        ```
        parser = pp.Parser(<Grammar>)
        ```
        
        where `<Grammar>` is a Grammar Object from the Parse Grammar Library.
        
        ## API Usage
        ```
        process = parser.run()
        ```
        
        where `type(process)` is `<class 'pexpect.pty_spawn.spawn'>`,
        - meaning that `process` is an object returned from `pexpect.spawn(<cmd>)`
        
        where `<cmd>` is the start symbol of `<Grammar>`
        - for more information about `<Grammar>` objects, see [parsegrammar](https://github.com/lorkaan/parsegrammar)
        
        ### Errors that can be thrown:
        
        - Timeout Error
        	- *Class* pexpect.exceptions.TIMEOUT
        - EOF Error
        	- *Class* pexpect.exceptions.EOF
        
        
        # Dependencies
        
        This project has the following dependencies:
        - Parse Grammar Library
        	- [Github](https://github.com/lorkaan/parsegrammar)
        	- [Pypi](https://pypi.org/project/parsegrammar/)
        	
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
