Metadata-Version: 2.4
Name: utils-separator
Version: 0.1.2
Summary: A lightweight Python utility for printing console separators.
Author: Steve
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# separator-utils

A lightweight Python utility for printing beautiful console separators.

## Features

- 🚀 Lightweight and easy to use
- 🎨 Custom separator characters
- 📏 Custom separator length
- 🔧 Custom prefix and suffix
- 📦 Ready for PyPI installation

---

## Installation

```bash
pip install utils-separator
```

---

## Quick Start

```python
from utils_separator.separator import separator

separator("Hello World")
```

Output:

```text
****************************** >>> Hello World <<< ******************************
```

---

## Examples

### Default

```python
from separator_utils import separator

separator("Start Processing")
```

Output

```text
****************************** >>> Start Processing <<< ******************************
```

---

### Custom Character

```python
separator("Loading Data", char="-")
```

Output

```text
------------------------------ >>> Loading Data <<< ------------------------------
```

---

### Custom Length

```python
separator("Training", length=50)
```

Output

```text
************************************************** >>> Training <<< **************************************************
```

---

### Custom Prefix & Suffix

```python
separator(
    "Completed",
    char="=",
    prefix="[",
    suffix="]"
)
```

Output

```text
============================== [ Completed ] ==============================
```

---

## API

### separator()

```python
separator(
    title: str,
    char: str = "*",
    length: int = 30,
    prefix: str = ">>>",
    suffix: str = "<<<"
)
```

### Parameters

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| title | str | Required | Separator title |
| char | str | "*" | Separator character |
| length | int | 30 | Number of separator characters |
| prefix | str | ">>>" | Left decoration |
| suffix | str | "<<<" | Right decoration |

---

## Example

```python
from separator_utils import separator

separator("Series")
separator("DataFrame", char="-")
separator("Finished", char="=", length=40)
```

Output

```text
****************************** >>> Series <<< ******************************
------------------------------ >>> DataFrame <<< ------------------------------
======================================== >>> Finished <<< ========================================
```

---

## License

MIT License

---

## Author

Steve
