pyargument 0.1.0

A lightweight Python command-line argument parser.

PyArgument

PyArgument is a lightweight Python command-line argument parser that allows defining multiple aliases for arguments, optional values, and default values. It is designed to be simple, flexible, and easy to use.

---

Features

• Add arguments with multiple aliases (e.g., --help, -h)
• Supports optional argument values (optarg=True)
• Handles default values
• Tracks which arguments were provided
• Provides attribute access for parsed arguments
• List all arguments, existing arguments, or aliases

---

Installation

Install locally

pip install .

Install via PIP

pip install pyargument

---

Usage

Example 1: Basic usage

from pyargument import PyArgument
import json
import os

def main():
    pwd = os.getcwd()
    parser = PyArgument()
    parser.add_arg("--online")
    parser.add_arg("--input", "-in", optarg=True, required=True)
    parser.add_arg("--dir", "--folder", optarg=True, default=pwd)
    parser.add_arg("--file", optarg=True)
    parser.add_arg("--pwd", "-p", "--cwd", required=True)

    parser.parse_args()
    
    print("Arguments metadata:", json.dumps(parser.list_all(), indent=4))
    print("Arguments provided:", parser.list_args())
    print("Arguments alias:", json.dumps(parser.list_alias(), indent=4))
    print("online:", parser.online)
    print("input:", parser.input)
    print("dir:", parser.dir)
    print("file:", parser.file)
    print("pwd:", parser.pwd)

Run from command line:

python your_script.py --yes --dir /tmp --file example.txt

---

Example 2: Aliases

parser.add_arg("--help", "-h", "-?")
parser.parse_args()
print(parser.help)  # True if any alias is used

• All aliases (--help, -h, -?) map to the same internal argument.
• Access via the main argument name (help).

---

Methods

add_arg(*names, optarg=False, default=None, required=True)

• *names: All aliases for this argument.
• optarg: If True, the argument can accept a value.
• default: Default value if argument not provided.
• required: Currently for future use; reserved.

parse_args(*args)

• Parses command-line arguments (sys.argv[1:]).
• Updates attributes of the parser object.

list_all()

• Returns a dictionary of all defined arguments and their metadata.

list_args()

• Returns a list of arguments that were provided in the command line.

list_alias()

• Returns a dictionary mapping each internal argument to all its aliases.

---

Example Output

$ python your_script.py --yes -d /tmp --file example.txt
Provided args: ['yes', 'dir', 'file']
yes: True
dir: /tmp
file: example.txt
pwd: /home/user

---

License

MIT License

---

Repository

https://github.com/ankushbhagats/pyargument