Create argparser automatically from functions
Project description
Overview
A wrapper around argparser to help build CLIs from functions. Uses type-hints extensively :snake:.
Setup
:gear: Installation
Install it directly into an activated virtual environment:
$ pip install arger
or add it to your Poetry project:
$ poetry add arger
:books: Usage
- create a python file called test.py
from arger import Arger
def main(param1: int, param2: str, kw1=None, kw2=False):
"""Example function with types documented in the docstring.
:param param1: The first parameter.
:param param2: The second parameter.
"""
print(locals())
if __name__ == '__main__':
Arger(main).run()
- run this normally with
python test.py 100 param2
- Checkout examples folder and documentation to see more of
argerin action.
Features
- Uses docstring to parse help comment for arguments. Supports
- Flags will be generated from parameter-name.
If needed you could declare it inside docstring like
:param arg1: -a --arg this is the document. Also one can usedef main(arg1:int=Option('-a', '--arg')): ... - The decorated functions can be composed to form nested sub-commands of any level.
- No external lib dependency
- Standard types supported. Please see examples for more supported types with examples.
- All argument to
ArgumentParser.add_argumentis supported. It can be updated witharger.Argumentorarger.Optionclasses. *argssupported but no**kwargssupport yet.- all optional arguments that start with underscore is not passed to
Parser. They are considered private to the function implementation. One can use_namespace_to get the output from theArgumentParser.parse_args()
Similar Projects
argh
- has similar goals as to ease up using argparser.
- doesn't support type hints.
- No recent releases.
typer
- if you are using
click, I highly recommend you to check this library. - it is neat and many features are drawn from it.
- doesn't support loading help text for arguments from docstrings.
invoke
- doesn't support type hints.
cliche
- has similar goals.
- doesn't cover much use cases as
arger.
cliar
- no docstring support for help argument.
Recommended Alternatives
Projects that I didn't know while creating this project. I highly recommend you to checkout them.
This project was generated with cookiecutter using jacebrowning/template-python.
Argparser enhancements
- web-ui : https://github.com/nirizr/argparseweb
- extra actions : https://github.com/kadimisetty/action-hero
- automatic shell completions using argcomplete
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
arger-1.0.7.tar.gz
(11.9 kB
view details)
Built Distribution
arger-1.0.7-py3-none-any.whl
(10.7 kB
view details)
File details
Details for the file arger-1.0.7.tar.gz.
File metadata
- Download URL: arger-1.0.7.tar.gz
- Upload date:
- Size: 11.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.8.6 Linux/5.4.0-1031-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4e94058ff4fa5ff253a346c270f2479bd8fcbe699cd9b5f8d1dcc9d811066fc9 |
|
| MD5 | 51497614d10a6eec65e47fe4c85e5917 |
|
| BLAKE2b-256 | ba8b6a17f718a81f76b3a757691a036ce83e2479aa087a32faee03c6358ae06b |
File details
Details for the file arger-1.0.7-py3-none-any.whl.
File metadata
- Download URL: arger-1.0.7-py3-none-any.whl
- Upload date:
- Size: 10.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.8.6 Linux/5.4.0-1031-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5532257900ad598f75b5cf7a56270ddbaf98bdc79d9ae8516c003f8eb649e98e |
|
| MD5 | 75ef3865a733de8e58397d6f64428132 |
|
| BLAKE2b-256 | 1cf3c392ee20cd5b9b078eebb4607d213e044246ac7fbcce1f06efe5c8baf461 |
