Professional Python client, CLI, and GUI for PixelDojo AI Image Generation API
Project description
PixelDojo
Professional Python client, CLI, and GUI for the PixelDojo AI Image Generation API.
Note: This is an unofficial community SDK, not affiliated with or endorsed by PixelDojo.
Features
- Async API Client: High-performance async client with sync wrapper, automatic retries, and connection pooling
- Beautiful CLI: Rich terminal output with progress bars, multiple output formats, and batch processing
- Modern Desktop GUI: PySide6-based application with dark theme, image gallery, and real-time generation
- Type-Safe: Full Pydantic models and type hints throughout
- Secure: Keyring-based API key storage
Installation
# Install from source
pip install -e /home/ares/pixeldojo
# Or install dependencies manually
pip install httpx pydantic pydantic-settings tenacity typer rich PySide6 pillow platformdirs keyring aiofiles
Quick Start
As a Library
from pixeldojo import PixelDojoClient
# Async usage (recommended)
async with PixelDojoClient(api_key="your-key") as client:
result = await client.generate(
"A beautiful sunset over mountains",
model="flux-pro",
aspect_ratio="16:9",
)
print(result.images[0].url)
# Sync usage
from pixeldojo import PixelDojoSyncClient
with PixelDojoSyncClient(api_key="your-key") as client:
result = client.generate("A cyberpunk cityscape")
for image in result.images:
print(image.url)
CLI
# Set API key (saved securely)
pixeldojo config set-key
# Generate an image
pixeldojo generate "A beautiful sunset over mountains"
# Generate with options
pixeldojo generate "Portrait of a cat" --model flux-1.1-pro --aspect-ratio 3:4 --num 2
# Output as JSON
pixeldojo generate "Logo design" --output json
# Download images
pixeldojo generate "Abstract art" --download ./output
# List available models
pixeldojo models
# List aspect ratios
pixeldojo ratios
# Launch GUI
pixeldojo gui
Desktop GUI
# Launch directly
pixeldojo-gui
# Or via CLI
pixeldojo gui
Available Models
| Model | Description |
|---|---|
flux-pro |
High-quality professional image generation |
flux-1.1-pro |
Enhanced Flux Pro with improved quality |
flux-1.1-pro-ultra |
Maximum quality Flux model |
flux-dev |
Development/testing Flux model |
qwen-image |
Optimized for text rendering in images |
wan-image |
Fast generation with cinematic style |
Aspect Ratios
1:1- Square (1024x1024)16:9- Landscape wide9:16- Portrait tall4:3- Landscape standard3:4- Portrait standard3:2- Landscape photo2:3- Portrait photo
Configuration
Environment variables:
PIXELDOJO_API_KEY: API authentication keyPIXELDOJO_API_URL: Base API URL (default: https://pixeldojo.ai/api/v1)PIXELDOJO_TIMEOUT: Request timeout in seconds (default: 120)PIXELDOJO_MAX_RETRIES: Maximum retry attempts (default: 3)PIXELDOJO_DEBUG: Enable debug mode
License
MIT License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pixeldojo-1.0.0.tar.gz
(32.8 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
pixeldojo-1.0.0-py3-none-any.whl
(32.2 kB
view details)
File details
Details for the file pixeldojo-1.0.0.tar.gz.
File metadata
- Download URL: pixeldojo-1.0.0.tar.gz
- Upload date:
- Size: 32.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4d0dda4c3fc424b17f02c1423c82bd4e78658d4cf7be0b59adb4d9b3af175c8d
|
|
| MD5 |
1fe8d50789cf3a3314b15c3c30631ffd
|
|
| BLAKE2b-256 |
c19d39bba0cd04b7b2e8c8b5b01bc703251ae7e6962b6574824d8c4b8e710187
|
File details
Details for the file pixeldojo-1.0.0-py3-none-any.whl.
File metadata
- Download URL: pixeldojo-1.0.0-py3-none-any.whl
- Upload date:
- Size: 32.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7c3699eb1c3ca7c15f80c374ab5b0eb843e4a6d981ede5434dc638b787396650
|
|
| MD5 |
801868a7a6ec256194e63804a023d6ec
|
|
| BLAKE2b-256 |
a4b0b9d5cf4b8e8a2e61c89d1dc063d2698678ffd447cf01df8fd5bb0812f658
|