Skip to main content

Lightweight argument parsing using a decorator

Project description

Build status PyPI Version

Parsable is a lightweight decorator-based command line parser library. Parsable was written to be simpler than argparse, optparse, and argh.

Installation

Install with pip

Parsable is already listed on PyPI, you can install with pip if you have the tool.

pip install --upgrade parsable

Install with setup.py

You can also run the setup.py from the source if you don’t have pip.

git clone https://github.com/fritzo/parsable.git
cd parsable
./setup.py install

Download directly

Just save parsable.py and add to your project.

Usage

Parsable uses just tiny pieces of syntax: a @parsable.command decorator, and a parsable.dispatch function.

  1. Import parsable

    import parsable
    
  2. Decorate functions you want parsed

    @parsable.command
    def my_function(required_arg, optional_bool=True, optional_int=1):
        '''Help messages are not just a good idea, they are required'''
        # parsable automatically converts types based on default arguments:
        assert isinstance(required_arg, str)
        assert isinstance(optional_string, bool)
        assert isinstance(optional_int, int)
        # ...
    
    @parsable.command
    def do_stuff_with_files(*filenames, inplace=True):
        '''This does something to each file'''
        # ...
    
  3. Dispatch at the end of the script

    if __name__ == '__main__':
        parsable.dispatch()
    
  4. Use your new script

    $ python my_script.py my_function demo optional_int=5
    ...
    
    # parsable replaces - with _ to make functions easier to read
    $ python my_script.py do-stuff-with-files *.py in-place=false
    ...
    

That’s it: only three little pieces of syntax!

LICENSE

Parsable is dual-licensed under the MIT and GPL2 licenses.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for parsable, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size parsable-0.1.2.tar.gz (3.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page