Metadata-Version: 2.1
Name: parseargs
Version: 0.0.4
Summary: A simple package for parsing function arguments from the command line
Home-page: https://github.com/AndrewNolte/ParseArgs
Author: Andrew Nolte
Author-email: anolte512@gmail.com
License: UNKNOWN
Description: # ParseArgs
        
        ##### A simple, intuitive way to parse command line arguments. Simply make a function, and call parseargs on it.
        * parses data types through annoations (annotations not required for string arguments)
        * parses optional keyword arguments by adding them as optional cli arguments
        * parses positional arguments in a variable called arglist (so don't use that as a keyword!)
        * adds a description of the command by using the signature of the method.
        
        ## Example
        
        
        in fun.py:
        ```python
        from parseargs import parseargs
        
        
        
        def fun(firstname, lastname:str, number:int = 5):
        	print(f"Hello {firstname} {lastname}")
        	print(f"Your number is {number}")
        	number *= 2
        	print(f"Twice your number is {number}")
        
        
        parseargs(fun)
        ```
        
        Now on the command line, you can do:
        
        ```shell
        $ python fun.py ricky bobby --number 5
        ```
        
        Notice how it will print out 10. If you remove the annotation declaring the number an int, it will instead print out 55, because it will interpret it as a string.
        
        
        We can get the method signature with:
        ```
        $ python fun.py -h
        usage: test2.py [-h] [--number NUMBER] arglist arglist
        
        signature = (firstname, lastname: str, number: int = 5)
        
        positional arguments:
          arglist
        
        optional arguments:
          -h, --help       show this help message and exit
          --number NUMBER
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
