Metadata-Version: 2.4
Name: pyforge-patterns
Version: 0.1.0
Summary: A Python package to generate ASCII art patterns like diamond, pyramid, triangle, rectangle, circle, and hourglass
Author: Rubab Fatima
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# PatternForge

A lightweight Python package to generate ASCII art patterns — diamond, pyramid, triangle, rectangle, circle, and hourglass.

## Installation

```bash
pip install patternforge
```

## Usage

```python
import patternforge

# Diamond
print(patternforge.diamond(5))

# Pyramid
print(patternforge.pyramid(5))

# Triangle
print(patternforge.triangle(5))

# Rectangle
print(patternforge.rectangle(width=6, height=4))

# Circle
print(patternforge.circle(6))

# Hourglass
print(patternforge.hourglass(5))
```

## Custom Characters

All functions accept an optional `char` parameter to change the pattern's symbol:

```python
print(patternforge.diamond(5, char="#"))
```

## Functions

| Function | Parameters | Description |
|----------|-----------|--------------|
| `diamond(size, char="*")` | size: int | Generates a diamond shape |
| `pyramid(size, char="*")` | size: int | Generates a pyramid shape |
| `triangle(size, char="*")` | size: int | Generates a right-angled triangle |
| `rectangle(width, height, char="*")` | width, height: int | Generates a rectangle |
| `circle(radius, char="*")` | radius: int | Generates a circle outline |
| `hourglass(size, char="*")` | size: int | Generates an hourglass shape |

## License

MIT License
