Provides a straightforward way to create command line arguments.
Project description
jarguments
simplifying args jargon
Summary
Provides a straightforward way to create command line arguments.
- :snake: Supports Python 3.8 and above. Tested on Windows 10.
- :warning: This project is still in development. Contributions are welcome!
- :star: The simplest way to show your support is to leave a star!
Contents
Installation
python -m pip install --upgrade jarguments
Usage
There are three steps to using the jarguments library:
-
Import the jarguments library.
from jarguments import create, parse
-
Provide your arguments with jarguments' classes.
# argument parser args = parse.JParser( # boolean argument create.JBool('show-text', helpstring='determines whether "text" is shown'), # integer argument create.JInt('number', default=1), # string argument create.JStr('text'), )
-
Use the outputs; they're parsed automatically!
if args.show_text: for _ in range(args.number): print(args.text)
Now it works just like any other command line application.
$ 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
-
The
--help
/-h
flag displays help messages:$ 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 ...]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
jarguments-0.2.0.tar.gz
(5.3 kB
view hashes)
Built Distribution
Close
Hashes for jarguments-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e87f077c5cc8ca9dfab60a7fbf8ccb118ce2a72760c40d85356b1f9b12469490 |
|
MD5 | bba2a501623b741876c3f815b712f14d |
|
BLAKE2b-256 | fd9f9f0571bab4b7269652226c8ecd350b5b7470383091e9ebd89e56a759dc38 |