jarguments 0.1.0

Providing a straightforward way to create command-line arguments.

jarguments

simplifying args jargon

Summary

Providing a straightforward way to create command-line arguments.

Works on Python 3.6 and above. Tested on Windows 10.

Contents

• Summary
• Contents
• Installation
• Usage
  • Library
  • Command-line

Installation

pip install jarguments

Usage

Library

There are three steps to using the jarguments library:

1. Import the jarguments library.

   import jarguments as j
   

2. Provide your arguments with jarguments' classes.

   args = j.JParser(
     j.JBool('show-text', help='determines whether "text" is shown'),
     j.JInt('number', default=1),
     j.JArgument('text', type=str, multiple=True),
   )
   

3. Use the outputs; they're parsed automatically!

   if args.show_text:
     for _ in range(args.number):
       print(args.text)
   

Command-line

• Now you can run your script with arguments:

  $ python example.py --show-text --text "hello" "world"
  ["hello", "world"]
  

• Arguments without a default value are required. If you don't provide them, the script will raise an error:

  $ python example.py --show-text
  error: the following arguments are required: --text
  

• If you want to see help messages, run your script with the -h or --help flag:

  $ python example.py -h
  usage: example.py [-h] [--show-text [SHOW_TEXT]] [--number NUMBER] --text [TEXT ...]
  
  options:
    -h, --help            show this help message and exit
    --show-text [SHOW_TEXT]
                          determines whether "text" is shown
    --number NUMBER
    --text [TEXT ...]