Metadata-Version: 2.1
Name: cli-forge
Version: 0.0.3
Summary: A tool for building simple CLIs
Project-URL: Homepage, https://github.com/JmThrCreator/cli-forge
Project-URL: Bug Tracker, https://github.com/JmThrCreator/cli-forge/issues
Author-email: Jonathan <jonathanfmaggio@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: windows-curses; os_name == 'nt'
Description-Content-Type: text/markdown

# CLI Forge

A tool for building simple CLIs

## Installation

`pip install pick`

## Input

### Basic

```py
from cli_forge import cli_forge

basic_input = cli_forge.cli_prompt("What is your name?")
```

### Select

```py
from cli_forge import cli_forge

cli_forge.select_input = cli_prompt("What currency will you be using?", options=["£", "$"], select=True)
```

### Multi-select

```py
from cli_forge import cli_forge

cli_forge.multi_select_input = cli_prompt("Which languages would you like to include?", options=["English", "Italian", "Spanish"], options_format=["EN", "IT", "ES"], multiselect=True)
```

### Options

- `prompt`: prompt above the options
- `options`: (optional) list of options
- `select`: (optional) if True, allows you select an option
- `multiselect`: (optional) if True, allows you to select multiple options
- `options_format`: (optional) allows you to format your output for use in your program

## Input

### Usage

```py
from cli_forge import cli_forge

cli_forge.cli_progress(10, 1, "Fetching data...")
# function
cli_forge.cli_progress(10, 2, "Fetching data...")
# ...
```

### Options

- `length`: number of progress units
- `progress`: progress level (out of length)
- `prefix`: text before the progress bar
- `size`: (optional) progress bar size on screen
- `end`: (optional) if True, allows you to end the progress bar before it completes