Metadata-Version: 2.3
Name: mono-pixel
Version: 0.1.2
Summary: a tool that converts your text and fonts into pixel img.
Requires-Dist: pillow>=10.0.0
Requires-Dist: typer>=0.12.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown


![mono-pixel logo](docs/mono-pixel-logo.png)

mono-pixel is a small Python library and CLI for rendering "pixel"-style text
images. Use any font you want.

# Installation

**Install directly (uvx / pipx)** — no clone required:

```bash
# via uvx (uv's transient runner)
uvx mono-pixel --help

# via pipx (isolated user install)
pipx install mono-pixel
```

**From source (clone)**:

```bash
# clone the repo
git clone https://github.com/czy014/mono-pixel.git
cd mono-pixel

# install with uv
uv sync
uv run mono-pixel --help

# or install globally with pip
pip install .
mono-pixel --help
```

# Usage

```bash
# just use
mono-pixel run
```

It will initiate an interactive mode to guide you through passing in some necessary parameters.

If you need a pure command-line, please refer to [Usage](docs/usage.md).

# Gallery

Check out the [Gallery](docs/gallery.md) to see mono-pixel in action with different pixel fonts!

License
This project is available under the terms described in the `LICENSE.txt` file.

