Skip to main content

reeln-cli plugin for OpenAI-powered LLM integration (metadata, translation, zoom)

Project description

reeln-plugin-openai

A reeln-cli plugin for OpenAI-powered LLM integration — livestream metadata, game thumbnails, playlist descriptions, and multi-language translation.

Features

  • Livestream metadata — LLM-generated title and description for game livestreams
  • Playlist metadata — creative playlist titles and descriptions
  • Game image thumbnails — ESPN/NBC Sports broadcast-style thumbnails from team logos via OpenAI image generation
  • Multi-language translation — batch or per-language translation with custom commentator personas
  • Prompt templates — customizable {{variable}} templates with override support

Install

pip install reeln-plugin-openai

Or for development:

git clone https://github.com/StreamnDad/reeln-plugin-openai
cd reeln-plugin-openai
make dev-install

Configuration

Add the plugin to your reeln config:

{
  "plugins": {
    "enabled": ["openai"],
    "settings": {
      "openai": {
        "enabled": true,
        "api_key_file": "~/.config/reeln/secrets/openai_api_key.txt",
        "model": "gpt-4.1",
        "playlist_enabled": true,
        "game_image_enabled": true,
        "game_image_output_dir": "~/Documents/game_images"
      }
    }
  }
}

API Key

The plugin resolves the OpenAI API key in this order:

  1. api_key_file config — reads key from the specified file (recommended)
  2. OPENAI_API_KEY environment variable — fallback for dev/CI

Config Fields

Field Type Default Description
enabled bool false Enable OpenAI LLM integration
api_key_file str "" Path to file containing the OpenAI API key
model str "gpt-4.1" OpenAI model for text generation
request_timeout_seconds float 30.0 API request timeout
prompt_overrides str (JSON) "{}" Dict of prompt name to override file path
prompt_context str (JSON) "{}" Dict of prompt name to extra context lines
translate_enabled bool false Enable multi-language translation
translate_languages str (JSON) "{}" Dict of language code to name
translate_per_language_prompts str (JSON) "{}" Dict of language code to prompt name
playlist_enabled bool false Enable LLM-generated playlist metadata
game_image_enabled bool false Enable game image thumbnail generation
game_image_model str "gpt-5.2" Model for image generation orchestration
game_image_renderer_model str "gpt-image-1.5" Model for image rendering
game_image_output_dir str "" Directory to save generated game images

Hooks

Hook What it does
ON_GAME_INIT Generates livestream metadata, playlist metadata, game image thumbnail, and translations

Shared Context

The plugin writes to context.shared for other plugins to consume:

context.shared["livestream_metadata"]  # {"title": "...", "description": "...", "translations": {...}}
context.shared["playlist_metadata"]    # {"title": "...", "description": "...", "translations": {...}}
context.shared["game_image"]           # {"image_path": "/path/to/thumbnail.png"}

Development

make dev-install    # uv venv + editable install with dev deps
make test           # pytest with 100% coverage
make lint           # ruff check
make format         # ruff format
make check          # lint + mypy + test

License

AGPL-3.0-only

Project details


Download files

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

Source Distribution

reeln_plugin_openai-0.4.0.tar.gz (35.8 kB view details)

Uploaded Source

Built Distribution

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

reeln_plugin_openai-0.4.0-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file reeln_plugin_openai-0.4.0.tar.gz.

File metadata

  • Download URL: reeln_plugin_openai-0.4.0.tar.gz
  • Upload date:
  • Size: 35.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for reeln_plugin_openai-0.4.0.tar.gz
Algorithm Hash digest
SHA256 4e864eb75d8d054fb2fc336328d3f881456164963a528950331ef4c3fe88a8d0
MD5 8d0f09238b3240e19dc1f7fdb4a6537b
BLAKE2b-256 a9af0341a3d1b8c33306564d3910acfa744c89bb230a8dffcaea56568c420c10

See more details on using hashes here.

Provenance

The following attestation bundles were made for reeln_plugin_openai-0.4.0.tar.gz:

Publisher: release.yml on StreamnDad/reeln-plugin-openai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file reeln_plugin_openai-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for reeln_plugin_openai-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc4e4c520bda824ea58aa62cee14c934956465a4bd0c9a8a86cacf6d05f48ff4
MD5 fa925699fccc9a1d59d4bd09f5953dbb
BLAKE2b-256 0b6986cb8ffa05d9b0c1dcbdef9e796434bbef18adaf0c4cb1cba63cd04d44eb

See more details on using hashes here.

Provenance

The following attestation bundles were made for reeln_plugin_openai-0.4.0-py3-none-any.whl:

Publisher: release.yml on StreamnDad/reeln-plugin-openai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page