Metadata-Version: 2.1
Name: pixellab
Version: 1.0.3
Summary: 
Author: PixelLab
Requires-Python: >=3.8,<4.0
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
Requires-Dist: eval-type-backport ; python_version < "3.10"
Requires-Dist: pillow
Requires-Dist: pydantic (>=2.0.0,<3.0.0)
Requires-Dist: pydantic-settings (>=2.0.0,<3.0.0)
Requires-Dist: requests (>=2.0.0,<3.0.0)
Description-Content-Type: text/markdown

# Pixel Lab Python SDK

[![PyPI version](https://badge.fury.io/py/pixellab.svg)](https://badge.fury.io/py/pixellab)
[![Python](https://img.shields.io/pypi/pyversions/pixellab.svg)](https://pypi.org/project/pixellab/)

This Python client simplifies interaction with the [Pixel Lab developer API](http://api.pixellab.ai/v1).

Create characters and items, animate them, and generate rotated views. Useful for game development and other pixel art projects.

For questions or discussions, join us on [Discord](https://discord.gg/pBeyTBF8T7).

## Features

- **Generate Image (Pixflux)**: Create characters, items, and environments from text descriptions
- **Generate Image (Bitforge)**: Use reference images to match a specific art style
- **Animation with Skeletons**: Animate bi-pedal and quadrupedal characters and monsters with skeleton-based animations
- **Animation with Text**: Animate with text prompts
- **Inpainting**: Edit existing pixel art
- **Rotation**: Generate rotated views of characters and objects

With much more functionality coming soon.

## Installation

Use your preferred package manager:

```bash
pip install pixellab
```

or

```bash
poetry add pixellab
```

## Usage

```python
import pixellab

client = pixellab.Client.from_env_file(".env.development.secrets")
# client = pixellab.Client.from_env()
# client = pixellab.Client(secret="my-secret")

# create image
response = client.generate_image_pixflux(
    description="cute dragon",
    image_size = {"width": 64, "height": 64},
)

response.image.pil_image()
```

See more client usage examples in the [Pixel Lab API Docs](https://api.pixellab.ai/v1/docs).

## Development

### Install Dependencies

```bash
poetry install
```

### Run Tests

```bash
poetry run pytest -s
```

## Support

- Documentation: [api.pixellab.ai/v1/docs](https://api.pixellab.ai/v1/docs)
- Discord Community: [Join us](https://discord.gg/pBeyTBF8T7)
- Issues: Please report any SDK issues on our GitHub repository

