# `clig` - CLI Generator

[![PyPI - Version](https://img.shields.io/pypi/v/clig.svg)](https://pypi.org/project/clig)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/clig.svg)](https://pypi.org/project/clig)

`clig` is a single module, written in pure python, that wraps around the
_stdlib_ module [`argparse`](https://docs.python.org/3/library/argparse.html) to
generate command line interfaces through simple functions.

If you know how to use
[`argparse`](https://docs.python.org/3/library/argparse.html), you may want to
use `clig`.

## Installation

Install with `pip`:

```PowerShell
pip install clig
```

Or just [download the module](./comparisons.md#download-the-module)

## Table of contents

```{toctree}
:maxdepth: 2

notebooks/userguide
notebooks/subcommands
notebooks/advancedfeatures
```

```{toctree}
:maxdepth: 1

docstrings_templates
api_reference
comparisons
```

## Links

- GitHub repository:
  [https://github.com/diogo-rossi/clig](https://github.com/diogo-rossi/clig)
- PyPI: [https://pypi.org/project/clig/](https://pypi.org/project/clig/)
- Documentation:
  [https://clig.readthedocs.io/en/latest/](https://clig.readthedocs.io/en/latest/)