Metadata-Version: 2.4
Name: img2pixel
Version: 0.1.0
Summary: Convert any image to pixel art for your terminal
Author: Andrés
License: MIT
Project-URL: Homepage, https://github.com/RooWiki/img2pixel
Project-URL: Bug Tracker, https://github.com/RooWiki/img2pixel/issues
Keywords: pixel-art,terminal,neofetch,ansi,ascii-art,linux
Classifier: License :: OSI Approved :: MIT License
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: Environment :: Console
Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
Classifier: Topic :: Terminals
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Pillow>=9.0
Dynamic: license-file

# img2pixel

Convert any image to pixel art for your terminal — perfect for [neofetch](https://github.com/dylanaraps/neofetch), [fastfetch](https://github.com/fastfetch-cli/fastfetch), or just for fun.

Uses Unicode half-block characters (`▀`) with true-color ANSI codes to render 2× vertical resolution per character row.

---

## Installation

**From PyPI:**
```bash
pip install img2pixel
```

**From source:**
```bash
git clone https://github.com/RooWiki/img2pixel
cd img2pixel
pip install .
```

---

## Usage

```
img2pixel <image> [options]
```

| Option | Default | Description |
|--------|---------|-------------|
| `-w`, `--width N` | `40` | Output width in terminal characters |
| `-b`, `--block N` | `4` | Pixel-art block size — higher = chunkier |
| `-c`, `--colors N` | unlimited | Limit color palette (e.g. `8`, `16`, `32`) |
| `-o`, `--output FILE` | stdout | Write result to file instead of printing |
| `-v`, `--version` | | Show version and exit |

---

## Examples

```bash
# Preview in terminal
img2pixel avatar.png

# Save for neofetch
img2pixel avatar.png -o ~/.config/art.txt
neofetch --ascii ~/.config/art.txt

# Retro look — chunky blocks, limited palette
img2pixel avatar.png -w 35 -b 6 -c 16

# Fine detail, no palette limit
img2pixel avatar.png -w 60 -b 2

# 8-bit style
img2pixel avatar.png -b 8 -c 8
```

---

## Neofetch integration

Generate the art file once and point neofetch to it:

```bash
img2pixel ~/Pictures/avatar.png -w 35 -o ~/.config/neofetch/art.txt
```

In your `~/.config/neofetch/config.conf`:
```bash
image_backend="ascii"
image_source="$HOME/.config/neofetch/art.txt"
```

---

## Requirements

- Python 3.8+
- [Pillow](https://python-pillow.org/) (`pip install Pillow`)
- A terminal with true-color support (most modern terminals)

---

## License

[MIT](LICENSE)
