Metadata-Version: 2.1
Name: arger
Version: 0.1
Summary: Create argparser automatically from functions
Home-page: https://pypi.org/project/arger
License: MIT
Author: Noortheen Raja
Author-email: jnoortheen@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: click (>=6.0,<7.0)
Requires-Dist: docstring-parser (>=0.6.1,<0.7.0)
Requires-Dist: minilog (>=1.4,<2.0)
Project-URL: Documentation, https://arger.readthedocs.io
Project-URL: Repository, https://github.com/jnoortheen/arger
Description-Content-Type: text/markdown

# Overview

A wrapper around argparser to help build CLIs from functions. Uses typehints extensively.

[![PyPi Version](https://img.shields.io/pypi/v/arger.svg?style=flat)](https://pypi.python.org/pypi/arger)
[![Python Version](https://img.shields.io/pypi/pyversions/returns.svg)](https://pypi.org/project/arger/)

[![Unix Build Status](https://img.shields.io/travis/jnoortheen/arger/master.svg?label=unix)](https://travis-ci.org/jnoortheen/arger)
[![Windows Build Status](https://img.shields.io/appveyor/ci/jnoortheen/arger/master.svg?label=windows)](https://ci.appveyor.com/project/jnoortheen/arger)
[![Coverage Status](https://img.shields.io/coveralls/jnoortheen/arger/master.svg)](https://coveralls.io/r/jnoortheen/arger)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/jnoortheen/arger.svg)](https://scrutinizer-ci.com/g/jnoortheen/arger/?branch=master)
[![PyPI Version](https://img.shields.io/pypi/v/arger.svg)](https://pypi.org/project/arger)
[![PyPI License](https://img.shields.io/pypi/l/arger.svg)](https://pypi.org/project/arger)

# Setup

## Installation

Install it directly into an activated virtual environment:

```text
$ pip install arger
```

or add it to your [Poetry](https://poetry.eustace.io/) project:

```text
$ poetry add arger
```

# Usage

After installation, the package can imported:

```text
$ python
>>> import arger
>>> arger.__version__
```

# Alternatives

## [argh](https://argh.readthedocs.io/en/latest/tutorial.html) 
 - has similar goals as to ease up using argparser. 
 - doesn't support type hints. 
 - No recent releases.

## [typer](https://github.com/tiangolo/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](http://www.pyinvoke.org/) 
 - doesn't support type hints.

## [cliche](https://github.com/kootenpv/cliche)
 - has similar goals. 
 - doesn't cover much use cases as `arger`.

This project was generated with [cookiecutter](https://github.com/audreyr/cookiecutter) using [jacebrowning/template-python](https://github.com/jacebrowning/template-python).
