Metadata-Version: 2.4
Name: pixel8
Version: 1.0.0
Summary: Generate pixel art from images using Canny edge detection
Author-email: Mehul Arora <aroramehul8@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/mehularora8/pixel8
Project-URL: Repository, https://github.com/mehularora8/pixel8
Project-URL: Issues, https://github.com/mehularora8/pixel8/issues
Keywords: pixel-art,image-processing,canny-edge-detection,computer-vision
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.19.0
Requires-Dist: matplotlib>=3.3.0
Requires-Dist: scikit-image>=0.18.0
Requires-Dist: Pillow>=8.0.0
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: black>=22.0; extra == "dev"
Requires-Dist: flake8>=4.0; extra == "dev"
Requires-Dist: mypy>=0.910; extra == "dev"
Dynamic: license-file

# pixel8

Generate pixel art from images using Canny edge detection.

## Overview

pixel8 is a Python package that transforms regular images into pixel art using the Canny edge detection algorithm. It's perfect for creating stylized artwork, tattoo designs, or just having fun with image processing.

## Installation

```bash
pip install pixel8
```

## Usage

### Command Line Interface

```bash
# Basic usage
pixel8 input.jpg 1.5

# Save output to file
pixel8 input.jpg 2.0 --output pixel_art.png

# Don't display the result
pixel8 input.jpg 1.5 --output result.png --no-show
```

### Python API

```python
import pixel8

# Generate pixel art
result = pixel8.create_pixel_line_art(
    image_path="input.jpg",
    pixelation_factor=1.5,
    output_path="output.png",
    show_result=True
)

# Use individual components
from pixel8 import gaussian_kernel, conv, gradient

# Create custom edge detection pipeline
kernel = gaussian_kernel(5, 1.2)
# ... rest of your pipeline
```

## Parameters

- **pixelation_factor** (float): Controls the pixelation threshold. Higher values = fewer pixels, more stylized result

## Requirements

- Python 3.8+
- NumPy
- Matplotlib
- scikit-image
- Pillow

## Development

```bash
# Clone the repository
git clone https://github.com/yourusername/pixel8.git
cd pixel8

# Install in development mode
pip install -e .

# Install development dependencies
pip install -e .[dev]
```

## Motivation

I stumbled across some beautiful pixel art and wanted to teach myself how to make it. I am also in the process of deciding what tattoo to get next. Thought I'd put the two together and design my next tattoo in pixel art.

## License

MIT License - see LICENSE file for details.
