Metadata-Version: 2.4
Name: custom-inputs
Version: 0.3.1
Summary: Custom terminal inputs for Python
Author: mm-sh
License: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# custom-inputs

Simple input utilities for Python terminal applications.

---

# Update

## v0.3

- add list_input()
- improve documations
- add installition
- improve error

---

# 📦 About

`custom-inputs` is a lightweight Python library that provides useful terminal input functions.

Features:

- Number input validation
- Multiple-choice menus
- List input
- Automatic input validation
- Easy to use

---

# 💻 Installation

```bash
pip install custom-inputs
```

---

# Functions

## number_input()

Read a validated number from the user.

### Example

```python
from custom_inputs import number_input

age = number_input(
    "Age: ",
    min=1,
    max=120,
    allow_negative=False
)
```

---

## multi_choice_input()

Create a terminal multiple-choice menu.

### Example

```python
from custom_inputs import multi_choice_input

color = multi_choice_input(
    "Choose a color:",
    "Red",
    "Blue",
    "Green",
    return_string=True
)
```

---

## list_input()

Read multiple lines from the user.

### Example

```python
from custom_inputs import list_input

foods = list_input(
    "Enter your favorite foods:",
    max_count=5
)

print(foods)
```

---

# License

MIT License
