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
argerin 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.
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 details)
Built Distribution
arger-0.1.3-py3-none-any.whl
(8.8 kB
view details)
File details
Details for the file arger-0.1.3.tar.gz.
File metadata
- Download URL: arger-0.1.3.tar.gz
- Upload date:
- Size: 8.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.5 CPython/3.8.2 Linux/5.0.0-1035-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3f937eee9dc71ae1825547fc199c5f73771b0aa42290d818e289f90efddffe6d |
|
| MD5 | 911749d65b438e9162da131d28ecd2a1 |
|
| BLAKE2b-256 | a5f9777423ff8a2c23d59c1da286f3d5f9940d7efafd5249a9caee19bf5daecd |
File details
Details for the file arger-0.1.3-py3-none-any.whl.
File metadata
- Download URL: arger-0.1.3-py3-none-any.whl
- Upload date:
- Size: 8.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.5 CPython/3.8.2 Linux/5.0.0-1035-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ae09e271de018c133118a9229fa2c2d8bddf7f9332dabc8d4e68ed616d401f6a |
|
| MD5 | cf3b9650037b6c69c6ec603327d89b10 |
|
| BLAKE2b-256 | 851549b588d4ce719b4a8bad15b3fc85c9fc37406d8b7e94edb558c5cdb4a97c |
