Create argparser automatically from functions
Project description
Overview
A wrapper around argparser to help build CLIs from functions. Uses typehints extensively.
Setup
Installation
Install it directly into an activated virtual environment:
$ pip install arger
or add it to your Poetry project:
$ poetry add arger
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
arger
in action.
Alternatives
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 inspired from this library.
- 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
.
This project was generated with cookiecutter using jacebrowning/template-python.
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
arger-0.1.3.tar.gz
(8.6 kB
view hashes)
Built Distribution
arger-0.1.3-py3-none-any.whl
(8.8 kB
view hashes)