Skip to main content

lexigram-multimedia-image

Image generation for the Lexigram Framework — local and API-based backends (local-http, stability, openai, comfyui).


Overview

lexigram-multimedia-image generates still images from a text prompt. The default backend calls a local HTTP reference server (http://localhost:5005) so the package works out of the box with no API keys; hosted backends (Stability AI, OpenAI) and ComfyUI workflows are selectable via config.

Full documentation: docs.lexigram.dev

Install

uv add lexigram-multimedia-image
# Optional extras
uv add "lexigram-multimedia-image[stability]"  # Stability AI API
uv add "lexigram-multimedia-image[openai]"     # OpenAI images API

Quick Start

from lexigram import Application
from lexigram.di.module import Module, module
from lexigram.multimedia.image import ImageModule
from lexigram.contracts.multimedia import ImageProvider, ImageRequest


@module(imports=[ImageModule.configure()])
class AppModule(Module):
    pass


async def main() -> None:
    async with Application.boot(modules=[AppModule]) as app:
        image = await app.container.resolve(ImageProvider)
        result = await image.generate(ImageRequest(prompt="a cozy cabin in the snow"))
        if result.is_ok():
            asset = result.unwrap()  # MediaAsset — image bytes or URI


if __name__ == "__main__":
    import asyncio

    asyncio.run(main())

Configuration

Zero-config usage: Call ImageModule.configure() with no arguments to use the local-http backend at http://localhost:5005.

Option 1 — YAML file

# application.yaml
multimedia:
  image:
    backend: "stability"
    comfyui_base_url: "http://localhost:8188"

Option 2 — Profiles + Environment Variables

export LEX_PROFILE=production
export LEX_MULTIMEDIA__IMAGE__BACKEND=openai
export LEX_MULTIMEDIA__IMAGE__OPENAI_MODEL=dall-e-3

Option 3 — Python

from lexigram.multimedia.image import ImageModule
from lexigram.multimedia.image.config import ImageConfig

ImageModule.configure(
    config=ImageConfig(backend="openai", openai_model="dall-e-3")
)

Config reference

Field Default Env var Description
backend "local-http" LEX_MULTIMEDIA__IMAGE__BACKEND local-http, stability, openai, comfyui
local_http_base_url "http://localhost:5005" LEX_MULTIMEDIA__IMAGE__LOCAL_HTTP_BASE_URL Local reference server URL
openai_api_key_secret_name "openai_api_key" LEX_MULTIMEDIA__IMAGE__OPENAI_API_KEY_SECRET_NAME Secret name for the OpenAI API key
openai_model "dall-e-3" LEX_MULTIMEDIA__IMAGE__OPENAI_MODEL OpenAI image model
openai_base_url "https://api.openai.com" LEX_MULTIMEDIA__IMAGE__OPENAI_BASE_URL OpenAI-compatible base URL
stability_api_key_secret_name "stability_api_key" LEX_MULTIMEDIA__IMAGE__STABILITY_API_KEY_SECRET_NAME Secret name for the Stability AI API key
comfyui_base_url "http://localhost:8188" LEX_MULTIMEDIA__IMAGE__COMFYUI_BASE_URL ComfyUI server URL
comfyui_checkpoint "sd_xl_base_1.0.safetensors" LEX_MULTIMEDIA__IMAGE__COMFYUI_CHECKPOINT ComfyUI checkpoint name
comfyui_workflow_path None LEX_MULTIMEDIA__IMAGE__COMFYUI_WORKFLOW_PATH Path to a custom ComfyUI workflow JSON
comfyui_steps 20 LEX_MULTIMEDIA__IMAGE__COMFYUI_STEPS ComfyUI sampling steps
comfyui_cfg_scale 7.0 LEX_MULTIMEDIA__IMAGE__COMFYUI_CFG_SCALE ComfyUI CFG scale
comfyui_poll_interval 1.0 LEX_MULTIMEDIA__IMAGE__COMFYUI_POLL_INTERVAL ComfyUI progress poll interval in seconds
timeout 60.0 LEX_MULTIMEDIA__IMAGE__TIMEOUT Request timeout in seconds

Module Factory Methods

Method Description
ImageModule.configure(config) Configure with explicit image config
ImageModule.stub() Real module pinned to the default local-http backend for tests

Key Features

  • Four backendslocal-http, stability, openai, comfyui
  • ComfyUI workflows — custom workflow JSON with checkpoint, steps, and CFG scale
  • Secret-managed API keys — provider keys resolved by name through the secrets backend
  • Result-basedgenerate() -> Result[MediaAsset, MultimediaError]; errors are domain values, not exceptions

Testing

from lexigram import Application
from lexigram.multimedia.image import ImageModule

async def test_boot():
    async with Application.boot(modules=[ImageModule.stub()]) as app:
        assert app.container is not None

Key Source Files

File What it contains
src/lexigram/multimedia/image/module.py ImageModule.configure() and .stub()
src/lexigram/multimedia/image/config.py ImageConfig
src/lexigram/multimedia/image/di/provider.py ImageGenerationProvider — registers ImageProvider, wires task handlers
src/lexigram/multimedia/image/providers/ Backend implementations (local_http, stability, openai, comfyui)
src/lexigram/multimedia/image/tasks.py Background generation task handlers
src/lexigram/multimedia/image/exceptions.py ImageGenerationError hierarchy

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lexigram_multimedia_image-0.1.3007-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

Details for the file lexigram_multimedia_image-0.1.3007-py3-none-any.whl.

File metadata

File hashes

Hashes for lexigram_multimedia_image-0.1.3007-py3-none-any.whl
Algorithm Hash digest
SHA256 0146ebfeca70168f9dbb7f7c4b8e44976b83165861ad2c4722128995bfbc9904
MD5 66626cd02f41d7685cefb9ae93a21be6
BLAKE2b-256 16b1b99e5443d0dee1ce692099dee4142b54608024400faf66fa43fa7318be6e

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.5008

1 file

0.1.5004

2 files

0.1.5001

2 files

This release

0.1.3007 This release

1 file

0.1.3006

1 file

0.1.3005

1 file

0.1.4

2 files

0.1.0

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page